Docstring markdown render overhaul (preserves markdown syntax), new features and bugfixes including no find_module AttributeError fix #85
+540
−197
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
…module" AttributeError Caused by modules not correctly loaded into namespace from commit due to Issue ml-tooling#57. Modules now correctly loaded into namespace. Fixes AttributeError("'FileFinder' object has no attribute 'find_module'") (ml-tooling#69) Prioritized "find_spec" and falls back to "find_module" from loader if find_spec not available. Some whitespace removal.
Modify argument regex Fix Colon use in docstring in arguments blocks now formatted correctly. Change argument detection to last colon in line. Added support for "Reference" as a block header. Convert quote block to admonition blocks Added Github admonition quote block support. Added start line anchor to regex Changed "```" code snippet boundary detection from startswith to regex to prevent false positives. Rework docstring markdown render. Solves issue ml-tooling#80 Improved whitespace and newline rendering. Accepts more native markdown syntax without garbling render. Solves Issue ml-tooling#82 Enumerate the docstring to detect end of docstring to appropriately close literal blocks, doctest and code blocks Update literal blocks logic and format. Syntax is same as reStructured text
ltan10
requested review from
lukasmasuch,
raethlein and
JanKalkan
as code owners
Add private_modules arg
…-tooling#72) Observed in python 3.8, constructor for dataclasses had different function signature
ltan10
force-pushed
the
feature/doc-to-md-overhaul
branch
from
dbf49cc to
fc350c8
Compare
ltan10
changed the title
|
@ltan10 Thanks for the update!! I will merge it as is but I need to apply some other fixes in the next few days to get the build/release pipeline working again. Btw. if you like, I can also make you a maintainer in this repo since - unfortunately - I don't have a lot of time for lazydocs. |
|
@lukasmasuch No worries, it has been a useful tool. And yeah happy to help as maintainer wherever i can. |
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.
What kind of change does this PR introduce?
Description:
mod_spec.loader.exec_module(mod)Line was not appending to parent argument, but appended on own line due to incorrect parsing as an argument.
--private-modulesand--no-private-modules. Defaults tono-private-modules--tocand--no-toc. Defaults tono-toc--url-line-prefix TEXT, defaults to None: which is github method of #Lxxx__create_fn__error (No support for dataclasses #72)Checklist: