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

Documentation change #3672

Merged
merged 13 commits into from
Aug 5, 2022
Merged

Documentation change #3672

merged 13 commits into from
Aug 5, 2022

Conversation

nlohmann
Copy link
Owner

@nlohmann nlohmann commented Aug 4, 2022 •
edited
Loading

  • Add all missing examples.
  • Add <!-- NOLINT --> comment to suppress warnings for missing sections.
  • Fix some errors (superfluous dots).
  • Adjust some line lengths.
  • Replace tabs with spaces.
  • Add API documentation linter to CI

@nlohmann nlohmann marked this pull request as draft August 4, 2022 14:47
@nlohmann @falbrechtskirchinger
Update docs/mkdocs/docs/api/macros/nlohmann_json_namespace.md
05c08a2 
Co-authored-by: Florian Albrechtskirchinger <falbrechtskirchinger@gmail.com>
@coveralls
Copy link

coveralls commented Aug 4, 2022 •
edited
Loading

Coverage Status

Coverage remained the same at 100.0% when pulling 3dcc260 on docs into 9e1a7c8 on develop.

falbrechtskirchinger
falbrechtskirchinger suggested changes Aug 5, 2022
View reviewed changes
Copy link
Contributor

@falbrechtskirchinger falbrechtskirchinger left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Found "a few" issues. :-)

FYI, I started using https://github.com/refined-github/refined-github recently, it visualizes whitespace changes (hence me being able to tell tabs from spaces).

docs/mkdocs/docs/api/basic_json/boolean_t.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/api/macros/json_use_global_udls.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/features/binary_formats/bjdata.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/features/binary_formats/messagepack.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/features/binary_formats/ubjson.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/features/binary_formats/ubjson.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/features/binary_formats/ubjson.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/features/binary_formats/ubjson.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/features/parsing/parse_exceptions.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/features/parsing/parser_callbacks.md Outdated Show resolved Hide resolved
@nlohmann
Copy link
Owner Author

nlohmann commented Aug 5, 2022

FYI, I started using refined-github/refined-github recently, it visualizes whitespace changes (hence me being able to tell tabs from spaces).

Very nice tool!

@nlohmann nlohmann marked this pull request as ready for review August 5, 2022 12:58
falbrechtskirchinger
falbrechtskirchinger approved these changes Aug 5, 2022
View reviewed changes
Copy link
Contributor

@falbrechtskirchinger falbrechtskirchinger left a comment

Choose a reason for hiding this comment

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

One minor suggestion. Rest looks good to me.

docs/mkdocs/docs/api/adl_serializer/from_json.md Outdated Show resolved Hide resolved
@nlohmann @falbrechtskirchinger
Update docs/mkdocs/docs/api/adl_serializer/from_json.md
3dcc260 
Co-authored-by: Florian Albrechtskirchinger <falbrechtskirchinger@gmail.com>
@nlohmann nlohmann added this to the Release 3.11.2 milestone Aug 5, 2022
@nlohmann nlohmann merged commit 7b6cf59 into develop Aug 5, 2022
@nlohmann nlohmann deleted the docs branch August 5, 2022 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@falbrechtskirchinger falbrechtskirchinger falbrechtskirchinger approved these changes

Assignees
No one assigned
Labels
CI CMake documentation L
Projects
None yet
Milestone
Release 3.11.2
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@nlohmann @coveralls @falbrechtskirchinger