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

Add more documentation and doctests to the builtins #107

Open
8 tasks
nekevss opened this issue Nov 3, 2024 · 0 comments
Open
8 tasks

Add more documentation and doctests to the builtins #107

nekevss opened this issue Nov 3, 2024 · 0 comments
Labels
C-documentation Improvements or additions to documentation C-tracking-issue Issues tracking a set of tasks that need to be done

Comments

@nekevss
Copy link
Member

nekevss commented Nov 3, 2024

Currently, the project has been relatively relaxed as far as documentation and doctests, but these are also incredibly useful for any users looking to use temporal_rs. Furthermore, it allows us to really get a better feel for the API while also providing more tests.

My initial thought is that we should try to have doctests for the builtins below and their main methods that may have high user visibility:

  • PlainDate
  • PlainDateTime
  • PlainTime
  • ZonedDateTime
  • Duration
  • Instant
  • PlainYearMonth
  • PlainMonthDay
@nekevss nekevss added C-documentation Improvements or additions to documentation C-tracking-issue Issues tracking a set of tasks that need to be done labels Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-documentation Improvements or additions to documentation C-tracking-issue Issues tracking a set of tasks that need to be done
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nekevss