Split doc test classes #1021
Merged
Split doc test classes #1021
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
* Fix references in ImportExport * Makes key generation more deterministic * Fix typos in docstrings and comments * Add the new versions of test_* in mathics.docpipeline, and keep the old ones when the new ones fail. * Make more deterministic the key generation for ``DocTest`` * DRY __init__ methods in classes inside latex_doc.py
removing trailing code
mmatera
force-pushed
the
split_DocTest_classes
branch
from
b55d03f to
30f39d7
Compare
This was referenced Mar 14, 2024
|
LGTM - thanks! |
rocky
added a commit
that referenced
this pull request
Apr 3, 2024
This continues #1021, and starts to tackle the problem of accessing tests by chapter and section without interacting over the full documentation. For chapters, the change is quite straightforward. On the other hand, for sections, I think we need to think a little bit what is the best way to do this. One possibility would be to produce the documentation entry from the docstring of the target builtin, without passing through the documentation. The other way to go would be to keep a dictionary in the documentation, storing all the sections "by slug". Thoughts? --------- Co-authored-by: rocky <[email protected]>
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.
Another thing that have been waiting to do: splitting
mathics.doc.common_docinto simpler, more specific pieces. I hope that this is going to help in the next steps (sorting the modules, accessing specific test cases in docpipeline, etc)This also includes
mathics.doc.common_docinto simpler more specific pieces: the structure ("Documentation/Chapter/Section..." incommon_docand the documentation entries itself (doc_entries) ).docpipeline.mathics.doc.common.DocTestbeing more deterministic.