Skip to content

Add docs to purecrypto functions #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
May 12, 2025
Merged

Add docs to purecrypto functions #268

merged 13 commits into from
May 12, 2025

Conversation

quexten
Copy link
Contributor

@quexten quexten commented May 9, 2025

🎟️ Tracking

📔 Objective

Adds docs to most functions on purecrypto, and renames generate to make to be in-line with the crate standard.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@quexten quexten requested a review from coroiu May 9, 2025 10:36
Base automatically changed from km/purecrypto-functions to main May 9, 2025 10:36
@quexten quexten changed the title Improve docs Add docs to purecrypto functions May 9, 2025
Copy link
Contributor

github-actions bot commented May 9, 2025

Logo
Checkmarx One – Scan Summary & Details0932087a-ab87-4971-9f79-5629d6aebfe6

Great job, no security vulnerabilities found in this Pull Request

Copy link

codecov bot commented May 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.81%. Comparing base (5449a5a) to head (003ce95).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #268   +/-   ##
=======================================
  Coverage   69.81%   69.81%           
=======================================
  Files         213      213           
  Lines       16809    16809           
=======================================
  Hits        11735    11735           
  Misses       5074     5074           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@quexten quexten marked this pull request as ready for review May 9, 2025 10:57
@quexten quexten requested a review from a team as a code owner May 9, 2025 10:57
quexten and others added 6 commits May 9, 2025 13:15
Co-authored-by: Andreas Coroiu <acoroiu@bitwarden.com>
Copy link

sonarqubecloud bot commented May 9, 2025

@quexten quexten requested a review from coroiu May 9, 2025 13:56
@quexten quexten merged commit 0b95464 into main May 12, 2025
42 checks passed
@quexten quexten deleted the km/improve-purecrypto-docs branch May 12, 2025 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants