Go over the documentation of the documentation system #982
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
* sort classes and functions in mathics.doc.common according to the order in doc-code-revision * adding docstrings * changing some names of classes and functions to be more explicit about the role in the system * adding pytest. * fix a typo (section ->section_all) in mathics.doc.latex_doc to allow load the GuideSections in the LaTeX documentation
mmatera
commented
Jan 31, 2024
|
|
||
| # If the last block in the loop was not a Text block, append the | ||
| # last set of tests. | ||
| if tests is not None: |
There was a problem hiding this comment.
Here is one of the "active" changes.
mmatera
commented
Jan 31, 2024
| @@ -774,7 +783,7 @@ def latex(self, doc_data: dict, quiet=False, filter_sections=None) -> str: | |||
| "\\chaptersections\n", | |||
| "\n\n".join( | |||
| section.latex(doc_data, quiet) | |||
| for section in sorted(self.sections) | |||
| for section in sorted(self.all_sections) | |||
There was a problem hiding this comment.
This is the other "active" change.
mmatera
commented
Jan 31, 2024
mathics/doc/common_doc.py
Outdated
| self.section, self.tests = section, doctests | ||
|
|
||
|
|
||
| # Note mmatera: I am confuse about this change of order in which the classes |
There was a problem hiding this comment.
Here I follow the order in #981 to make the comparisons easier.
Some docstring corrections/elaborations, change few comments, some spelling corrections and some lint.
|
LGTM - let's merge and iterate. |
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.
This PR is mainly about clarifying the code in the documentation system
gather_testsfunction previously reported in Fix gather tests and start adding pytests #981.