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

Documentation isn't entirely clear #2

Open
sagebind opened this issue Oct 23, 2020 · 0 comments
Open

Documentation isn't entirely clear #2

sagebind opened this issue Oct 23, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@sagebind
Copy link
Owner

sagebind commented Oct 23, 2020 •
edited
Loading

Got some good feedback about the documentation yesterday, such as:

  • Include a summary of #[unstable] in the crate-level docs
  • Include more of the documentation in the readme as well
  • Explain how this interacts with crate features
  • Show a code example of what the macro expands to
  • Create a "mock" demo module that shows what generated docs look like
    • I wonder, can a proc macro use a previous version of itself to do this?
@sagebind sagebind added the documentation Improvements or additions to documentation label Oct 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sagebind