Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update module docstrings for API documentation #903

Merged
merged 2 commits into from
Mar 16, 2021

Conversation

rahulporuri
Copy link
Contributor

@rahulporuri rahulporuri commented Mar 13, 2021

This PR updates the module docstrings for a number of api submodules to improve the autogenerated API documentation.

Poruri Sai Rahul added 2 commits March 13, 2021 14:02
	modified:   pyface/api.py
	modified:   pyface/data_view/api.py
	modified:   pyface/dock/api.py
	modified:   pyface/fields/i_combo_field.py
	modified:   pyface/fields/i_field.py
	modified:   pyface/tree/api.py
	modified:   pyface/viewer/api.py
	modified:   pyface/viewer/tree_item.py
@rahulporuri rahulporuri changed the title [WIP] Module docstrings for API documentation Update module docstrings for API documentation Mar 16, 2021
Copy link
Contributor

@aaronayres35 aaronayres35 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rahulporuri rahulporuri merged commit 6581385 into master Mar 16, 2021
@rahulporuri rahulporuri deleted the doc/api-doc-strings branch March 16, 2021 12:05
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.

2 participants