Skip to content

Bugfix: module loading, failed toc generation, aggressive argument regex, md rendering, other improvements and fixes.#101

Open
ltan10 wants to merge 13 commits intoml-tooling:mainfrom
ltan10:bugfix/module-loading-and-md-format
Open

Bugfix: module loading, failed toc generation, aggressive argument regex, md rendering, other improvements and fixes.#101
ltan10 wants to merge 13 commits intoml-tooling:mainfrom
ltan10:bugfix/module-loading-and-md-format

Conversation

@ltan10
Copy link
Copy Markdown
Contributor

@ltan10 ltan10 commented Mar 10, 2026

What kind of change does this PR introduce?

  • Bugfix
  • New Feature
  • Feature Improvment
  • Refactoring
  • Documentation
  • Other, please describe:

Description:

Checklist:

  • I have read the CONTRIBUTING document.
  • My changes don't require a change to the documentation, or if they do, I've added all required information.

Changed terminology of dataclass attribute header to fields.
Dataclass with no attributes now no longer display `attribute/fields` header.
Implement inclusion of class prefix for dataclasses.
…ontent

Added missing include_toc docstring arg for generate_docs
Fixed docstring for toc2md method.
toc2md now return empty string if TOC is empty.

TOC now includes summary description
Fix imported modules incorrectly listed as global variable.
Values of global variables are now displayed.
…ooling#97) and improve argument parsing performance

* Collapsed args regex matching to optimize performance, performing only a single test.
* Argument name is stricter for python var naming convention
Deprecate usage of find_module() and fixed incorrect find_spec() usage
Min python version for lazydoc is still 3.6+ due to fstring usage. (ml-tooling#94)

Implement workaround for when relative imports is used in top level modules:
Remove reliance on adding to sys.path for relative imports.
Rework generator for directory style imports.
Rework generator for module in sys.path style imports.
Rework generator for file style imports.
Show doc output location for verbosity.
Update exception message if path is not recognized to be more meaningful.
Relative imports will only work for modules at same or lower level.
@ltan10 ltan10 force-pushed the bugfix/module-loading-and-md-format branch from 9f86241 to 38ca824 Compare April 24, 2026 00:08
ltan10 added 2 commits April 24, 2026 10:26
Feat: Add support for `or` and `|` separator for argtype matching.
Chore: Explicitly greedily match square brackets.
Chore: Refactor _RE_BLOCKSTART_LIST regex pattern.
Fix: Duplicate `kwargs` pattern in _RE_BLOCKSTART_LIST
Feat: Add `Methods` to _RE_BLOCKSTART_LIST pattern
@ltan10 ltan10 force-pushed the bugfix/module-loading-and-md-format branch from 38ca824 to 0165b88 Compare April 24, 2026 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken output when a docstring has a string like https:// error: option --overview-file not recognized

1 participant