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

Improvements to docs #123

Merged
merged 4 commits into from
Oct 4, 2024
Merged

Improvements to docs #123

merged 4 commits into from
Oct 4, 2024

Conversation

nicoburns
Copy link
Contributor

  • Simplify public module hierarchy (make some modules private and re-export types instead)
  • Re-export all types at the top level (making use of wildcard re-exports to avoid cluttering the docs)
  • Add a usage example and basic documentation to lib.rs

@nicoburns nicoburns added the documentation Improvements or additions to documentation label Oct 4, 2024
DJMcNab
DJMcNab reviewed Oct 4, 2024
View reviewed changes
Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

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

Overall looks good, just a few peripheral thoughts

parley/src/context.rs Outdated Show resolved Hide resolved
parley/src/font.rs Outdated Show resolved Hide resolved
parley/src/context.rs Show resolved Hide resolved
parley/src/font.rs Outdated Show resolved Hide resolved
parley/src/font.rs Show resolved Hide resolved
parley/src/lib.rs Outdated Show resolved Hide resolved
waywardmonkeys
waywardmonkeys approved these changes Oct 4, 2024
View reviewed changes
Copy link
Contributor

@waywardmonkeys waywardmonkeys left a comment

Choose a reason for hiding this comment

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

A bunch of nits and as Daniel mentioned a bunch of missing full stops at the end of stuff.

Also, please make sure that this doesn't have warnings or (new) clippy lints with a current nightly from your lifetime changes.

parley/src/lib.rs Outdated Show resolved Hide resolved
parley/src/lib.rs Outdated Show resolved Hide resolved
parley/src/lib.rs Outdated Show resolved Hide resolved
parley/src/lib.rs Outdated Show resolved Hide resolved
@nicoburns
Copy link
Contributor Author

please make sure that this doesn't have warnings or (new) clippy lints with a current nightly from your lifetime changes.

The lifetime changes were to make nightly clippy happy in the first place!

@nicoburns nicoburns added this pull request to the merge queue Oct 4, 2024
@nicoburns nicoburns added this to the 0.2 Release milestone Oct 4, 2024
Merged via the queue into linebender:main with commit be9e9ab Oct 4, 2024
20 checks passed
@nicoburns nicoburns deleted the minimal-docs branch October 4, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DJMcNab DJMcNab DJMcNab left review comments

@waywardmonkeys waywardmonkeys waywardmonkeys approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.2 Release
Development

Successfully merging this pull request may close these issues.
3 participants
@nicoburns @waywardmonkeys @DJMcNab