mkdocstrings/griffe issues and pull requests

#137 - Properly documenting the return type in the "Returns" section when using google docstring style

Issue - State: closed - Opened by tazend over 1 year ago - 6 comments
Labels: feature

#136 - Unresolved aliases

Issue - State: closed - Opened by femtomc over 1 year ago - 15 comments
Labels: wildcard-imports

#135 - feat: Forward class attribute docstrings to instances.

Pull Request - State: closed - Opened by rodrigogiraoserrao over 1 year ago - 3 comments

#134 - Support cython `embedSignature`

Issue - State: closed - Opened by multimeric over 1 year ago - 4 comments
Labels: feature, out of scope

#133 - Code blocks break if contain `\n`

Issue - State: closed - Opened by LukeSavefrogs over 1 year ago - 3 comments

#132 - Support docstring formats: Google, NumPy, ReST

Issue - State: closed - Opened by SamuelMarks over 1 year ago - 7 comments
Labels: feature

#131 - Allow ignoring single files or properties

Issue - State: closed - Opened by LukeSavefrogs over 1 year ago - 7 comments
Labels: feature

#130 - Include the location of the mistake in case of a "Could not resolve X" error

Issue - State: closed - Opened by Aran-Fey over 1 year ago - 15 comments
Labels: feature

#129 - Extra table rows for `Returns` when empty lines start with spaces

Issue - State: closed - Opened by LukeSavefrogs over 1 year ago - 5 comments

#128 - Question: can I do anything about docstrings for attributes being picked up from last location

Issue - State: closed - Opened by rodrigogiraoserrao over 1 year ago - 5 comments

#127 - docs: minor typo fixes

Pull Request - State: closed - Opened by thatlittleboy over 1 year ago

#126 - fix: support editable install with multiple roots

Pull Request - State: closed - Opened by gilfree over 1 year ago - 1 comment

#125 - Avoiding rtype checks with typed code: No return type or annotation at ':return: ...

Issue - State: closed - Opened by ssbarnea over 1 year ago - 5 comments

#124 - submodules overshadow imports of the same name

Issue - State: closed - Opened by machow over 1 year ago - 7 comments
Labels: bug

#123 - griffe 0.25.1 errors with CyclicRedundancy on `uuid`

Issue - State: closed - Opened by digitaldogsbody almost 2 years ago - 11 comments

#122 - Infinite recursion in griffe (again)

Issue - State: closed - Opened by roastduck almost 2 years ago - 8 comments
Labels: bug, wildcard-imports

#121 - griffe cannot find valid inline injection links

Issue - State: closed - Opened by nerdoc almost 2 years ago - 3 comments

#120 - AttributeError: can't set attribute 'overloads'

Issue - State: closed - Opened by tlambert03 almost 2 years ago - 4 comments

#119 - Fix deepcopy issue

Pull Request - State: closed - Opened by pawamoy almost 2 years ago

#118 - numpy docstring parses a section named "Examples", but not "Example"

Issue - State: closed - Opened by machow almost 2 years ago - 2 comments

#117 - [BUG] `tuple[int, int] | None` causes IndexError, but `Optional[tuple[int, int]]` does not

Issue - State: closed - Opened by bczsalba about 2 years ago - 2 comments

#116 - overloads without implementations (in stub files) are not detected

Issue - State: closed - Opened by tlambert03 almost 2 years ago - 6 comments
Labels: bug, wildcard-imports

#115 - fix: catch recursion in Alias.resolved

Pull Request - State: closed - Opened by tlambert03 almost 2 years ago - 5 comments

#114 - `AliasResolutionError` with a suspected fix.

Issue - State: closed - Opened by deepandas11 almost 2 years ago - 3 comments
Labels: bug

#113 - feature: API checks: Check for types compatibility

Issue - State: open - Opened by pawamoy almost 2 years ago - 4 comments
Labels: feature

#112 - KeyError on multiple nested namespace packages

Issue - State: closed - Opened by ffaraone almost 2 years ago - 6 comments

#111 - Incorrect type reference in code.

Issue - State: closed - Opened by Tonivalle almost 2 years ago - 1 comment

#110 - Refactor CLI

Pull Request - State: closed - Opened by pawamoy almost 2 years ago

#109 - fix: Log debug instead of errors when failing to parse NumPy annotations for additional sections

Pull Request - State: closed - Opened by sisp almost 2 years ago - 3 comments

#108 - feat: support typing_extensions.overload

Pull Request - State: closed - Opened by BlueGlassBlock almost 2 years ago - 3 comments

#107 - fix: Don't strip too many parentheses on the right of a call node

Pull Request - State: closed - Opened by pawamoy almost 2 years ago

#106 - Web links are rendered as regular text.

Issue - State: closed - Opened by andreas-vester almost 2 years ago - 2 comments

#105 - feat: Add function to find API breaking changes

Pull Request - State: closed - Opened by pawamoy almost 2 years ago - 1 comment

#104 - Bug: Various new "griffe: Failed to parse annotation from 'BoolOp' node at file" errors

Issue - State: closed - Opened by shaypal5 about 2 years ago - 7 comments

#103 - fix: Guard against more alias resolution errors

Pull Request - State: closed - Opened by pawamoy about 2 years ago

#102 - Bug: Various new "griffe: Failed to parse annotation from 'BoolOp' node at file" errors

Issue - State: closed - Opened by shaypal5 about 2 years ago - 2 comments

#101 - fix: expand empty module failed when `next_module.exports` is `None`

Pull Request - State: closed - Opened by hfudev about 2 years ago - 3 comments

#100 - Always use `encoding="utf8"` when reading text files.

Pull Request - State: closed - Opened by rudolfbyker about 2 years ago - 1 comment

#99 - UnicodeDecodeError when docstrings contain ASCII art

Issue - State: closed - Opened by rudolfbyker about 2 years ago - 2 comments

#98 - Line numbers are wrong on Python 3.7

Issue - State: closed - Opened by pawamoy about 2 years ago - 1 comment
Labels: bug

#97 - IndexError in numpy docstring parser

Issue - State: closed - Opened by krzysztof3-wisniewski about 2 years ago - 3 comments
Labels: bug

#96 - Docstrings are not inherited

Issue - State: closed - Opened by davfsa about 2 years ago - 17 comments

#95 - `typing.Tuple` not treated like a subscriptable object

Issue - State: closed - Opened by 2bndy5 about 2 years ago - 10 comments

#94 - KeyError in GriffeLoader.load_module if two or more dots in python file name

Issue - State: closed - Opened by MikhailPasechnik about 2 years ago - 3 comments
Labels: bug

#93 - Boolean operation in NumPy-style type annotation raises error

Issue - State: closed - Opened by sisp about 2 years ago - 13 comments

#92 - Module Exports are None

Issue - State: closed - Opened by DarkaMaul about 2 years ago - 6 comments
Labels: bug

#91 - Module loading failure

Issue - State: closed - Opened by hlorus over 2 years ago - 8 comments

#90 - Improve Docstring location information

Issue - State: closed - Opened by analog-cbarber over 2 years ago - 5 comments
Labels: feature, griffe: docstrings

#89 - `AliasResolutionError` during merge_stubs (preventing mkdocstrings from working)

Issue - State: closed - Opened by tlambert03 over 2 years ago - 2 comments

#88 - Alternative implementation of relative-to-absolute

Issue - State: closed - Opened by pawamoy over 2 years ago

#87 - Error when generating site using mkdocs serve with mkdocstrings

Issue - State: closed - Opened by jeffginger over 2 years ago - 4 comments

#86 - Support for string literal references

Issue - State: closed - Opened by Kigstn over 2 years ago - 6 comments
Labels: feature

#85 - fix: ignore comments in .pth files

Pull Request - State: closed - Opened by GabDug over 2 years ago - 2 comments

#84 - Pth file formatting breaks griffe

Issue - State: closed - Opened by samrensenhouse over 2 years ago - 2 comments

#83 - Infinite recursion in griffe

Issue - State: closed - Opened by roastduck over 2 years ago - 6 comments
Labels: bug, wildcard-imports

#82 - Adding docs from a package that is installed fails with KeyError: <class 'ast.BoolOp'>

Issue - State: closed - Opened by galwiner over 2 years ago - 7 comments

#81 - Cannot resolve builtin `typing` modules.: `griffe.exceptions.AliasResolutionError: Could not resolve typing.Dict`

Issue - State: closed - Opened by jessekrubin over 2 years ago - 18 comments
Labels: bug

#80 - agent/nodes.py cannot parse f-string when it's numeric

Issue - State: closed - Opened by nicolefinnie over 2 years ago - 5 comments

#79 - Stub Files and Wildcard Expansion issues

Issue - State: closed - Opened by LordOfPolls over 2 years ago - 11 comments
Labels: bug, wildcard-imports

#78 - fix: fix stub merging for single-file packages

Pull Request - State: closed - Opened by tlambert03 over 2 years ago - 7 comments

#77 - Feature: support type stubs?

Issue - State: closed - Opened by tlambert03 over 2 years ago - 3 comments
Labels: feature

#76 - feat: add load_git, to load Module from a git committish

Pull Request - State: closed - Opened by tlambert03 over 2 years ago - 3 comments

#75 - Feature: API diffing utils & change detection.

Issue - State: closed - Opened by tlambert03 over 2 years ago - 10 comments
Labels: feature

#74 - feat: add to/from_json convenience methods to Object

Pull Request - State: closed - Opened by tlambert03 over 2 years ago - 5 comments

#73 - AliasResolutionError on `getattr` problematic for things like deepcopy

Issue - State: closed - Opened by tlambert03 over 2 years ago - 6 comments
Labels: bug

#72 - Unable to build documentation for the ibis project

Issue - State: closed - Opened by cpcloud over 2 years ago - 16 comments
Labels: bug, wildcard-imports

#70 - griffe/src/griffe/agents/nodes.py would be worth being a separate package

Issue - State: closed - Opened by tristanlatr over 2 years ago - 6 comments
Labels: feature

#69 - Poor documentation of multiple items in Returns docstring

Issue - State: closed - Opened by Bluenix2 over 2 years ago - 13 comments
Labels: documentation, docstrings

#67 - Add support to ignore files

Issue - State: closed - Opened by dmulyalin over 2 years ago - 6 comments
Labels: feature

#64 - docstrings/sphinx: Support "warn unknown params" feature

Issue - State: closed - Opened by pawamoy over 2 years ago - 2 comments
Labels: help wanted, good first issue, feature, docstrings, sphinx

#58 - support for namespace packages with init.py file

Issue - State: closed - Opened by analog-cbarber over 2 years ago - 10 comments

#57 - infinite recursion in GriffeLoader.expand_wildcards

Issue - State: closed - Opened by analog-cbarber over 2 years ago - 4 comments
Labels: bug, wildcard-imports

#52 - Refactor docstrings sections

Pull Request - State: closed - Opened by pawamoy over 2 years ago

#50 - Explore events/signals as a way to extend functionality

Issue - State: closed - Opened by pawamoy over 2 years ago - 1 comment

#49 - docstrings/sphinx: Support "trim_doctest_flags" option

Issue - State: closed - Opened by thatlittleboy over 2 years ago - 1 comment
Labels: help wanted, good first issue, feature, docstrings, sphinx

#45 - docstrings/sphinx: Support "ignore init summary" option

Issue - State: closed - Opened by pawamoy over 2 years ago - 1 comment
Labels: help wanted, good first issue, docstrings, sphinx