#1910 Add formal time period type to documentation
Reporter
Vito
Owner
Nobody
Created
Updated
Stars
★ (1)
Tags
Priority-Medium
Status-New
Type-Defect
Component-Docs
Vito
on
Details:
The config options like archive_expires_after and http_file_share_expires_after should have their own type, say time_period, which would help to understand what values are appropriate.
I think it should contain the following statements
Number of seconds:
- 10 - 10 seconds
- 1.5 * 60 - 1.5 minutes
- 60 * 60 - 1 hour
- 86400 - 1 day
- 24 * 60 * 60 + 60 - 1 day and 1 minute
Number of units:
- "1 second"
- "5 seconds"
- "10 minutes"
- "15 hours"
- "20 days"
- "25 months"
- "30 years"
Infinite number:
- "never"
Additional:
I think the short forms like "1m" should be removed from the documentation altogether.
Ref: https://hg.prosody.im/trunk/rev/80a1ce9974e5
Details: The config options like archive_expires_after and http_file_share_expires_after should have their own type, say time_period, which would help to understand what values are appropriate. I think it should contain the following statements Number of seconds: - 10 - 10 seconds - 1.5 * 60 - 1.5 minutes - 60 * 60 - 1 hour - 86400 - 1 day - 24 * 60 * 60 + 60 - 1 day and 1 minute Number of units: - "1 second" - "5 seconds" - "10 minutes" - "15 hours" - "20 days" - "25 months" - "30 years" Infinite number: - "never" Additional: I think the short forms like "1m" should be removed from the documentation altogether. Ref: https://hg.prosody.im/trunk/rev/80a1ce9974e5