Data

Tools

Indexes

Applications

Experiments

Issues

An open API service for providing issue and pull request metadata for open source projects.

GitHub / mkdocstrings/pytkdocs issues and pull requests

#150 - Decorator to ignore specific functions during the docstrings "discovery"

Issue - State: open - Opened by Skrattoune about 2 years ago - 4 comments
Labels: feature

#149 - pytkdocs/django compatibility issues

Issue - State: open - Opened by jmcgill298 almost 4 years ago - 5 comments
Labels: unconfirmed

#147 - Decorators which alternate docstrings are ignored

Issue - State: open - Opened by braniii over 2 years ago - 3 comments

#146 - `inherited_members` Does **Not** Work

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

#144 - [BUG] 'builtin_function_or_method' object is not subscriptable

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

#142 - [BUG] detect_field_model fails for DjangoModelFactory from factory-boy

Issue - State: open - Opened by mschoettle over 3 years ago - 3 comments

#141 - [BUG] Wrong docstrings for attribute when aliased from another class

Issue - State: open - Opened by aminalaee over 3 years ago - 2 comments

#140 - [BUG] type unions with pipes not supported

Issue - State: open - Opened by analog-cbarber over 3 years ago - 2 comments

#139 - [BUG] use of `set` as class attribute type causes exception

Issue - State: closed - Opened by JoeHCQ1 over 3 years ago - 5 comments

#138 - fix: warn about missing descriptions and return "" not `None`

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

#137 - [BUG] missing numpydoc parameters validation resulting in Nonetype exception

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

#136 - docs: Fix numpy parser docstrings

Pull Request - State: closed - Opened by thatlittleboy over 3 years ago - 1 comment

#135 - [DOCS] Docstrings don't match up with function parameters

Issue - State: closed - Opened by thatlittleboy over 3 years ago - 1 comment

#134 - feat: Add `trim_doctest_flag` to google and numpy parsers

Pull Request - State: closed - Opened by thatlittleboy over 3 years ago - 5 comments

#132 - Line numbers in error messages

Issue - State: open - Opened by analog-cbarber over 3 years ago - 1 comment
Labels: feature

#130 - chore: Template upgrade

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

#128 - build: Remove upper bounds on production dependencies

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

#127 - Add support for help_text field parameter as description with django model fields.

Issue - State: closed - Opened by mabugaj over 3 years ago
Labels: feature

#126 - Template upgrade

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

#124 - [BUG] Support typing-extensions 4.x

Issue - State: closed - Opened by lyz-code over 3 years ago - 2 comments

#123 - [BUG] Pydantic model fields don't display in documentation

Issue - State: open - Opened by ysfchn over 3 years ago - 4 comments

#122 - [BUG] Wrong version from python package

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

#121 - feat: Add Markdown docstring-style support

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

#120 - fix: add source to class object

Pull Request - State: closed - Opened by jakekaplan almost 4 years ago - 1 comment

#119 - Nasty direct path to own types.

Issue - State: closed - Opened by Bluenix2 almost 4 years ago - 2 comments
Labels: feature

#118 - pass context to parse_docstring

Pull Request - State: closed - Opened by jakekaplan almost 4 years ago - 5 comments

#117 - Fails on __init__() method with valid but peculiar indentation

Issue - State: closed - Opened by dirkroorda almost 4 years ago - 7 comments
Labels: wontfix

#116 - Support google yields sections

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

#115 - refactor: Remove warning about new path style option

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

#114 - fix: Skip 'could not read code' errors for special methods

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

#113 - fix: Support future annotations

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

#112 - Implement terminal colors for Windows

Issue - State: closed - Opened by ArneBachmannDLR almost 4 years ago - 1 comment
Labels: feature

#111 - [BUG] collections.namedtuple leads to source not found warning

Issue - State: closed - Opened by ArneBachmannDLR almost 4 years ago - 1 comment
Labels: feature

#110 - Initial fix to switch order of preference for using docstring annotat…

Pull Request - State: closed - Opened by ghandic almost 4 years ago - 5 comments

#109 - fix: Fix getting parent module of decorated functions

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

#108 - Include base classes in output

Pull Request - State: closed - Opened by bkoropoff about 4 years ago - 6 comments

#107 - [BUG] Enum's __class__ etc. are pulled in when inherited_members is true

Issue - State: open - Opened by yi2020 about 4 years ago - 3 comments

#106 - Filter based on class inheritance

Issue - State: open - Opened by yi2020 about 4 years ago - 1 comment
Labels: feature

#105 - feat: Support "Keyword Args" sections for G-style

Pull Request - State: closed - Opened by HacKanCuBa about 4 years ago - 6 comments

#104 - [BUG] pytkdocs must be installed with 'numpy-style'

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

#103 - [FEATURE] Allow method_descriptors to be serialized as methods

Pull Request - State: closed - Opened by jmrgibson over 4 years ago - 3 comments

#102 - [BUG] No error information from parsing python source

Issue - State: closed - Opened by jmrgibson over 4 years ago - 5 comments
Labels: unconfirmed

#101 - Add support for Django models

Pull Request - State: closed - Opened by mRokita over 4 years ago - 4 comments

#100 - Bugfix duplicate dataclass attributes

Pull Request - State: closed - Opened by bstadlbauer over 4 years ago - 13 comments

#99 - Incorrect function's argument representation with 2 underscores

Issue - State: closed - Opened by deknowny over 4 years ago - 5 comments

#98 - Adapt Loader to Support docstrings in Cython Extension Modules

Pull Request - State: closed - Opened by suned over 4 years ago - 4 comments

#97 - [BUG] Upgrading to 0.11.0 fails -- Can't find README

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

#96 - Fix annotations parsing errors

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

#95 - Fix pydantic field documentation for List/Set/Tuple

Pull Request - State: closed - Opened by shashankrnr32 over 4 years ago - 3 comments

#94 - [BUG] Pydantic Field documentation generates wrong type for List/Set/Tuple

Issue - State: closed - Opened by shashankrnr32 over 4 years ago - 1 comment

#93 - [BUG] individually annotated attributes in __init__ not discovered

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

#92 - [BUG] AttributeError: 'Name' object has no attribute 'value' (again)

Issue - State: closed - Opened by pawamoy over 4 years ago - 3 comments
Labels: bug

#90 - [BUG] Properties do not inherit superclass docstrings

Issue - State: closed - Opened by jayqi over 4 years ago - 2 comments
Labels: bug

#89 - Support 'Yields' in Google-style docstrings

Issue - State: closed - Opened by jvfe over 4 years ago - 4 comments
Labels: good first issue, docstrings, feature, docstrings-format:google

#88 - Support "Keyword Arguments" sections in Google-style docstrings

Issue - State: closed - Opened by pawamoy over 4 years ago - 3 comments
Labels: feature

#87 - feat: Add support for Numpy docstrings

Pull Request - State: closed - Opened by aschmu over 4 years ago - 7 comments

#86 - Doesn't report a cached_property

Issue - State: closed - Opened by oprypin over 4 years ago - 5 comments
Labels: bug

#85 - fix: Allow newer version of dataclasses backport

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

#84 - [BUG?] wxPython breaks mkdocstrings

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

#83 - Attribute annotation (and its docstring) doesn't show up unless it has a value

Issue - State: closed - Opened by oprypin over 4 years ago - 5 comments
Labels: bug

#82 - fix: Ignore errors parsing c-extension modules

Pull Request - State: closed - Opened by bigeagle over 4 years ago - 1 comment

#81 - fix: Fix attribute parser for Python 3.9

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

#80 - Expose type alias instead of actual type

Issue - State: closed - Opened by plannigan over 4 years ago - 3 comments
Labels: feature

#79 - Plugin/hook system

Issue - State: closed - Opened by pawamoy over 4 years ago - 1 comment
Labels: feature

#78 - Remove new_path_syntax option

Issue - State: closed - Opened by pawamoy over 4 years ago - 1 comment
Labels: wontfix, selection-options

#77 - Switch new_path_syntax default value to True

Issue - State: closed - Opened by pawamoy over 4 years ago - 1 comment
Labels: wontfix, selection-options

#76 - fix: Avoid recursion if a class has a reference to itself.

Pull Request - State: closed - Opened by matthewwardrop over 4 years ago - 3 comments

#75 - AttributeError Name object has no attribute value

Issue - State: closed - Opened by pawamoy over 4 years ago - 3 comments
Labels: bug, attributes

#74 - Allow using "import" path of an object rather than the "real path" (where it was defined)

Issue - State: closed - Opened by pawamoy over 4 years ago - 1 comment
Labels: feature

#73 - [BUG] Dict[] type annotations make pytkdocs explode

Issue - State: closed - Opened by nigelm almost 5 years ago - 5 comments
Labels: bug, annotations

#72 - Update README to include conda build

Pull Request - State: closed - Opened by bandersen23 almost 5 years ago - 1 comment

#71 - feat: Add initial restructured text docstirng parsing

Pull Request - State: closed - Opened by plannigan almost 5 years ago - 7 comments

#70 - Explicitly test with no arguments

Pull Request - State: closed - Opened by plannigan almost 5 years ago - 1 comment

#69 - [BUG] Dataclass Initialisation argument types and defaults not detected

Issue - State: closed - Opened by beanaroo almost 5 years ago - 2 comments
Labels: bug

#68 - chore: Update CI workflow into a better state

Pull Request - State: closed - Opened by plannigan almost 5 years ago - 3 comments

#67 - Add reStructured parser

Issue - State: closed - Opened by plannigan almost 5 years ago - 5 comments
Labels: feature

#66 - Accept dotted-paths of the form path.to.module:object1.object2

Issue - State: closed - Opened by pawamoy almost 5 years ago - 1 comment
Labels: feature, module:loader, error-handling

#65 - Add async property for coroutine functions

Pull Request - State: closed - Opened by art049 almost 5 years ago - 3 comments

#64 - Refactor

Issue - State: closed - Opened by pawamoy almost 5 years ago - 5 comments
Labels: wontfix, refactor

#63 - Allow to specify what exactly is a docstring for a given class

Issue - State: open - Opened by yajo almost 5 years ago - 2 comments
Labels: feature

#62 - parser not picking up methods of enums if not explicitly told to

Issue - State: closed - Opened by FlixMa almost 5 years ago - 2 comments
Labels: bug, module:loader

#61 - Add Enum values

Issue - State: closed - Opened by StephenBrown2 almost 5 years ago - 3 comments
Labels: feature

#58 - Enable the inheritance of classmethod for docstrings

Issue - State: open - Opened by cgarciae about 5 years ago - 4 comments
Labels: bug, docstrings, module:loader

#53 - CollectionError swallows exception

Issue - State: closed - Opened by stufisher about 5 years ago - 2 comments
Labels: error-handling

#52 - Dataclasses attributes get picked up twice

Issue - State: closed - Opened by pawamoy about 5 years ago - 4 comments
Labels: bug, module:loader, attributes

#50 - Support default values for pydantic fields

Issue - State: closed - Opened by chbndrhnns about 5 years ago - 5 comments
Labels: feature

#48 - Guess object type when not annotated

Issue - State: closed - Opened by pawamoy about 5 years ago - 1 comment
Labels: annotations, feature

#46 - Use a JSONEncoder

Issue - State: closed - Opened by pawamoy about 5 years ago - 1 comment
Labels: refactor

#44 - Mock unavailable libraries

Issue - State: closed - Opened by AchimKern about 5 years ago - 4 comments
Labels: documentation, wontfix, feature, mkdocstrings

#39 - Add support for django models

Issue - State: closed - Opened by mRokita about 5 years ago - 3 comments
Labels: feature, module:loader

#29 - Return members in the same given order

Issue - State: open - Opened by pawamoy about 5 years ago - 6 comments
Labels: feature, module:loader, selection-options

#14 - Support more objects properties

Issue - State: closed - Opened by pawamoy over 5 years ago - 1 comment
Labels: properties, feature

#13 - Idea: link builtin types and exceptions to their resp. docs

Issue - State: closed - Opened by pawamoy over 5 years ago - 3 comments
Labels: annotations, feature, cross-linking

#12 - Store dotted path for annotations types that are within the package

Issue - State: closed - Opened by pawamoy over 5 years ago - 1 comment
Labels: annotations, feature, cross-linking

#7 - [FeatureRequest] Support the numpy docstring format

Issue - State: closed - Opened by dhirschfeld over 5 years ago - 7 comments
Labels: feature, docstrings-format