Skip to content
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

Added crate feature requirements to docs #64

Merged
merged 2 commits into from
Jan 19, 2024
Merged

Added crate feature requirements to docs #64

merged 2 commits into from
Jan 19, 2024

Conversation

AntonnMal
Copy link
Contributor

Steam algorithm was hidden from docs and some functions were not marked as feature-locked.

Also, some notes that are outside of this PR:

  • Shadowing feature-gated functions is probably a bad idea because they do not show up in docs and lead to inconsistent examples (e.g. secret.rs)
  • Is digits being outside of the 6..=8 range unwanted behavior? If so, then why not use an enum?

Note: This change was not tested on docs.rs, only using local cargo:

cargo +nightly rustdoc --all-features -- --cfg docsrs

Copy link
Owner

@constantoine constantoine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! Thank you for your PR. I just have a few question, but it looks good! I found some examples to update yesterday, after merging I'll probably fix those up too before publishing the next version

src/lib.rs Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
Comment on lines +21 to +22
all-features = true
rustc-args = ["--cfg", "docsrs"]
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll admit I've never went too far with rustdocs. This is nice to know, thank you :)

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7873dc0) 94.78% compared to head (de61f0a) 94.87%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #64      +/-   ##
==========================================
+ Coverage   94.78%   94.87%   +0.08%     
==========================================
  Files           6        6              
  Lines        1420     1443      +23     
==========================================
+ Hits         1346     1369      +23     
  Misses         74       74              

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

@constantoine constantoine merged commit 17844d6 into constantoine:master Jan 19, 2024
4 checks passed
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.

3 participants