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

Add a module docstring to the api modules #1441

Merged
merged 2 commits into from
Dec 16, 2020
Merged

Conversation

rahulporuri
Copy link
Contributor

@rahulporuri rahulporuri commented Dec 11, 2020

This PR adds a module docstring to the traitsui.api and traitsui.editors.api modules.

	modified:   traitsui/api.py
	modified:   traitsui/editors/api.py
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, just a nit and a general question

traitsui/api.py Outdated Show resolved Hide resolved
@@ -1,3 +1,52 @@
""" API for traitsui.editors subpackage.
Copy link
Contributor

Choose a reason for hiding this comment

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

unrelated to this PR, but why do we have this api module if these are all already exposed in the traitsui.api?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I do not have an answer to this question :D
Not sure how long the traitsui.editors.api has existed and why it existed - and if we want to keep it around.

	modified:   traitsui/api.py
@rahulporuri rahulporuri merged commit 4033285 into master Dec 16, 2020
@rahulporuri rahulporuri deleted the doc/api-module branch December 16, 2020 10:37
@rahulporuri rahulporuri moved this from In Progress to Done in Enthought OSS Q4 2020 Dec 16, 2020
@rahulporuri rahulporuri moved this from Done to Sprint 6 : Dec 14 2020 - Jan 2 2021 in Enthought OSS Q4 2020 Jan 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Enthought OSS Q4 2020
Sprint 6 : Dec 14 2020 - Jan 2 2021
Development

Successfully merging this pull request may close these issues.

None yet

2 participants