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

Iso doc fixes #215

Merged
merged 3 commits into from
Sep 20, 2022
Merged

Iso doc fixes #215

merged 3 commits into from
Sep 20, 2022

Conversation

lukem
Copy link
Contributor

@lukem lukem commented Aug 7, 2022

I've made a few fixes to the Boost.Date_Time documentation (including comments):

  1. The fractional separator has always been implemented (back to 2002) as ".", but the documentation sometimes used ",". I've fixed the documentation
  2. Consistently use "ISO 8601" to refer to the standard, instead of just "iso" or "ISO".
  3. Consistently document that fractional seconds are only included if non-zero. This fixes Issue to_iso_extended_string documentation wrong about fraction print #110.

The fractional separator for the various to_iso_* methods
is "." not "," (per to_iso_string_type() implementation).
Fix the documentation to match the implementation.
The standard is "ISO 8601", so use that instead
of just "iso" or "ISO" in comments and documentation.
Consistently document that the fractional seconds
are only included if non-zero.

Use "where fffffffff" not "were fff".
@JeffGarland
Copy link
Collaborator

This looks good to me -- thanks!

@JeffGarland JeffGarland merged commit ddcfd00 into boostorg:develop Sep 20, 2022
@lukem lukem deleted the iso_doc_fixes branch September 22, 2022 01:56
JeffGarland added a commit that referenced this pull request Oct 31, 2022
* fix typo in time_period docs (#212)

Co-authored-by: Quinn O'Connor <qoconnor@fastenal.com>

* Fix constexpr of gregorian::date::date(special_values) to improve perf (#214)

GCC up to at least 10.2 fail to resolve
gregorian::date::date(special_values) as constexpr function due to
assignment to *this within the constructor. Refactoring constructor to
initialize the instance once leads to large performance improvement.

* Avoid using likely function as multiple projects define a likely macro (#216)

* Iso doc fixes (#215)

* to_iso_*string() use "." as fractional separator

The fractional separator for the various to_iso_* methods
is "." not "," (per to_iso_string_type() implementation).
Fix the documentation to match the implementation.

* use "ISO 8601" not "iso" in documentation

The standard is "ISO 8601", so use that instead
of just "iso" or "ISO" in comments and documentation.

* fractional seconds only included if non-zero (#110)

Consistently document that the fractional seconds
are only included if non-zero.

Use "where fffffffff" not "were fff".

* Fix ccache saving on cache hit (#211)

See boostorg/boost-ci#166

* chore: bump macos runner version (#213)

GitHub Action is sunsetting the macOS 10.15 Actions runner. It will stop working intermittently until being completely removed by 2022-8-30: https://github.blog/changelog/2022-07-20-github-actions-the-macos-10-15-actions-runner-image-is-being-deprecated-and-will-be-removed-by-8-30-22

Co-authored-by: Quinnsicle <qtoconnor@gmail.com>
Co-authored-by: Quinn O'Connor <qoconnor@fastenal.com>
Co-authored-by: Povilas Kanapickas <povilas@radix.lt>
Co-authored-by: Antony Polukhin <antoshkka@gmail.com>
Co-authored-by: Luke Mewburn <luke@mewburn.net>
Co-authored-by: Alexander Grund <Flamefire@users.noreply.github.com>
Co-authored-by: Baoshuo Ren <i@baoshuo.ren>
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.

2 participants