Enhance manual - #19
Merged
Merged
Conversation
- expand introduction clarifying Alexandria's prefixes - move example discussion to the relevant section - convert `full: true` to `false` to condense the manual and better illustrate the numbering behavior - tidy up sections numbering, disable Bibliographies numbering
- hide the internal implementation details - condense redundancies - clarify the role of prefixes and read function
it is not required, as alexandria is the only module in the manual
ensko
reviewed
Jul 14, 2025
Contributor
Author
|
@SillyFreak Thank you for the review! I have addressed your comments. I've also further slightly tweaked some docstrings (see 8995490), I hope you are ok with these late changes. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
It is a subset of #18 that only updates the manual (the new API introduced by #18 is not discussed) and the docstrings:
full: truetofalseto condense the manual and better illustrate the numbering behavior