Skip to content

Add docstrings to methods #2

@IvoMerchiers

Description

@IvoMerchiers

When programming using the python-benedict, I like to use the fact that my IDE can automatically show docstrings for methods. This way, you don't have to constantly look up the source code or guess the meaning of parameters.

You pretty much have all of this information in the readme.md, so it might be good to copy that into your code.
Ideally, you can then automatically generate more extensive and searchable documentation with sphinx.


Example:

>>> from benedict import benedict
>>> test_dict = benedict({"a": 1})
>>> help(test_dict.clean)

Help on method clean in module benedict.dicts:

clean(strings=True, dicts=True, lists=True) method of benedict.dicts.benedict instance

This is not informative and should return a proper docstring.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions