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

add hyperlinks to documentation and clarify derive macros #355

Merged
merged 1 commit into from
May 12, 2024

Conversation

lolbinarycat
Copy link
Contributor

this makes it easier to navigate the documentation.

one comment seemed to suggest that the reexport of the derive macros was depricated, however that has been ignored for several reasons:

  1. exposing macros through a derive feature flag is common practice, see the serde crate for an example.
  2. using a feature flag means you can't accidentally have a version mismatch.
  3. the reexport is used in several examples
  4. the only evidence of deprication is a private comment, which would never be seen by normal users of the crate.

this makes it easier to navigate the documentation.

one comment seemed to suggest that the reexport of the derive
macros was depricated, however that has been ignored for several
reasons:

1. exposing macros through a derive feature flag is common practice,
   see the serde crate for an example.
2. using a feature flag means you can't accidentally have a version
   mismatch.
3. the reexport is used in several examples
4. the only evidence of deprication is a private comment,
   which would never be seen by normal users of the crate.
@Peternator7 Peternator7 merged commit 9689d7b into Peternator7:master May 12, 2024
1 check failed
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