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.

Sign up for GitHub

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

Jump to bottom

Fix non-hidden docs on docs.rs #280

Merged
merged 4 commits into from
Jul 26, 2023
Merged

Fix non-hidden docs on docs.rs #280

merged 4 commits into from
Jul 26, 2023

Conversation

tyranron
Copy link
Collaborator

Resolves #276, #278

Synopsis

See #276:

Somehow docs.rs is displaying all re-exported traits anyway. Eventhough they are marked as #[docs(hidden)].

Solution

  1. Do not import traits when building on docs.rs (fixes Hide re-exported traits from docs.rs #276).
  2. Use macro@ prefix for README intra-doc links to disambiguate them with traits (fixes Links in "trait" overview do not point to derive macros. #278).

The result can be checked by running the command reproducing docs.rs build nearly:

RUSTDOCFLAGS='--cfg docsrs' cargo rustdoc -p derive_more --features full --open

Checklist

  • Documentation is updated (if required)
  • Tests are added/updated (not required)
  • CHANGELOG entry is added (not required)

@tyranron tyranron added the docs label Jul 26, 2023
@tyranron tyranron added this to the 1.0.0 milestone Jul 26, 2023
@tyranron tyranron self-assigned this Jul 26, 2023
@tyranron tyranron requested a review from JelteF July 26, 2023 16:41
@tyranron
Copy link
Collaborator Author

Also fixed version in README.

JelteF
JelteF reviewed Jul 26, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
JelteF
JelteF previously approved these changes Jul 26, 2023
View reviewed changes
@tyranron @JelteF
Update version in README to be strict
4fc9b6a 
Co-authored-by: Jelte Fennema <github-tech@jeltef.nl>
@tyranron tyranron requested a review from JelteF July 26, 2023 16:59
@tyranron tyranron merged commit f067867 into master Jul 26, 2023
16 checks passed
@tyranron tyranron deleted the fix-docsrs branch July 26, 2023 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JelteF JelteF JelteF approved these changes

Assignees

@tyranron tyranron

Labels
docs
Projects
None yet
Milestone
1.0.0
Development

Successfully merging this pull request may close these issues.

Links in "trait" overview do not point to derive macros. Hide re-exported traits from docs.rs
2 participants
@tyranron @JelteF