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.

Sign up for GitHub

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

Jump to bottom

Document Date, Datetime and Time traits in the "Predefined traits" section of the user manual #1445

Closed
mdickinson opened this issue Mar 15, 2021 · 2 comments · Fixed by #1641
Closed

Document Date, Datetime and Time traits in the "Predefined traits" section of the user manual #1445

mdickinson opened this issue Mar 15, 2021 · 2 comments · Fixed by #1641
Labels
component: documentation Issues related to the Sphinx documentation type: enhancement

Comments

@mdickinson
Copy link
Member

mdickinson commented Mar 15, 2021 •
edited
Loading

These are commonly-used traits, which should be documented. The allow_datetime flag to Date, and the allow_none flags to all three trait types, are worthy of mention.
@mdickinson mdickinson added component: documentation Issues related to the Sphinx documentation type: enhancement labels Mar 15, 2021
@mdickinson mdickinson mentioned this issue Mar 15, 2021
Merged
4 tasks
@mdickinson mdickinson mentioned this issue May 9, 2022
Closed
rahulporuri pushed a commit that referenced this issue May 10, 2022
DOC: Document Date, Datetime and Time traits
8df6327 
fixes #1445

	modified:   docs/source/traits_user_manual/defining.rst
@rahulporuri rahulporuri mentioned this issue May 10, 2022
Merged
4 tasks
rahulporuri pushed a commit that referenced this issue May 10, 2022
Document "Date", "Datetime" and "Time" trait types (#1641)
9af04c7 
* DOC: Document Date, Datetime and Time traits

fixes #1445

	modified:   docs/source/traits_user_manual/defining.rst

* CLN: Address review comments

	modified:   docs/source/traits_user_manual/defining.rst
@rahulporuri
Copy link
Contributor

@mdickinson was anything else needed to close this issue?

@mdickinson
Copy link
Member Author

@rahulporuri When I wrote the issue, I was thinking that it would be nice to have a more detailed explanation of allow_none, allow_datetime, etc., in the user manual. But it may be that the existing docstrings for the trait types are enough here.

mdickinson pushed a commit that referenced this issue Aug 9, 2022
@mdickinson
Document "Date", "Datetime" and "Time" trait types (#1641)
e3f76a0 
* DOC: Document Date, Datetime and Time traits

fixes #1445

	modified:   docs/source/traits_user_manual/defining.rst

* CLN: Address review comments

	modified:   docs/source/traits_user_manual/defining.rst

(cherry picked from commit 9af04c7)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component: documentation Issues related to the Sphinx documentation type: enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document "Date", "Datetime" and "Time" trait types enthought/traits
2 participants
@mdickinson @rahulporuri