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

Issue 1913/docs add more datetime examples #1914

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

chwt
Copy link

@chwt chwt commented Aug 18, 2024

Closes #1913

To have more examples of supported supported humanized datetime strings, added a file extracted from unit tests of the used datetime parsing dependency (https://github.com/bear/parsedatetime).

Questions/comments:

  • I rather wanted to have as many examples as possible, but is the current list too much?
    • The file is located in a new directory docs/res/. Should it be moved somewhere else?
    • First, I had the grep command, which is used to extract the file, in the file itself as header. Then thought that it will rather confuse the documentation users. Currently it is part of the commit message. What would be alternatives?
  • Please provide any suggestions for better phrasing of the added documentation change.

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • I have checked to ensure there aren't other open pull requests
    for the same issue.
  • I have written new tests for these changes, as needed. (docs only)

note: commited file was generated from parsedatetime project (https://github.com/bear/parsedatetime)
with command
```
git grep --only-matching --heading -P "(?<=cal.parse\(')[^']*(?=')" -- :tests/* :^*Australian* :^*Errors* :^*German* :^*Locale* :^*Russian* | grep -v -P '.*\.py|\$300|300ml|25:23|14/32/2015|anhour|an hamburger'
```
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.

Have more examples of supported humanized datetime formats
1 participant