Improve read/write-fonts root crate documentation #549
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dfrg
approved these changes
Aug 1, 2023
Comment on lines
+12
to
+14
| //! they have a similar structure, where a `tables` module contains a submodule for | ||
| //! each supported [table][table-directory], and that module contains items for | ||
| //! each table, record, flagset or enum described in the spec. This means that |
There was a problem hiding this comment.
This is a great description of the code layout. Can we add this to the read-fonts docs as well? I think the duplication is worth it.
This adds a bunch more information to the root crate documentation, which show up on docs.rs.
These are the docs that appear on docs.rs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The module docs in
lib.rsare the docs that show up on the main page of docs.rs, and since apparently some people are actually using these crates I think it would be nice if we could make it slightly less painful for them. 💁