Skip to content

Cleanup documentation#4667

Merged
vitaut merged 3 commits intofmtlib:masterfrom
ssszcmawo:doc_cleanup
Feb 5, 2026
Merged

Cleanup documentation#4667
vitaut merged 3 commits intofmtlib:masterfrom
ssszcmawo:doc_cleanup

Conversation

@ssszcmawo
Copy link
Contributor

I did some light cleanup in the docs: corrected mistakes, removed unnecessary repetitions, and fixed punctuation.

doc/api.md Outdated
// Parses format specifiers and stores them in the formatter.
//
// [ctx.begin(), ctx.end()) is a, possibly empty, character range that
// (ctx.begin(), ctx.end()) is a, possibly empty, character range that
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The [ is an indicator of a half-open interval, not a parenthetical comment.
https://en.wikipedia.org/wiki/Interval_(mathematics)#Half-open_intervals

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad, didn't know about it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed

doc/api.md Outdated

`fmt/base.h` defines the base API which provides main formatting functions
for `char`/UTF-8 with C++20 compile-time checks. It has minimal include
for `char`/UTF-8, with C++20 compile-time checks. It has minimal include
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think comma is needed here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I realized after submitting the pull request that it's not really needed there xd, already removed it

Copy link
Contributor

@vitaut vitaut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small comment, otherwise LGTM.

Corrected formatting and grammar in the API documentation.
@vitaut vitaut merged commit 28b082c into fmtlib:master Feb 5, 2026
41 checks passed
@vitaut
Copy link
Contributor

vitaut commented Feb 5, 2026

Merged, thank you!

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.

3 participants