Skip to content

Revise the contents of API References #445

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

Merged
merged 6 commits into from
Dec 17, 2024
Merged

Conversation

fktn-k
Copy link
Owner

@fktn-k fktn-k commented Dec 17, 2024

This PR has made a lot of changes to the contents of API references to provide more structured, detailed information of each APIs. (A number of typos and copy and paste mistakes were also fixed...)
Along the way, dependencies to build the documentation site have also been updated.


Pull Request Checklist

Read the CONTRIBUTING.md file for detailed information.

  • Changes are described in the pull request or in a referenced issue.
  • The test suite compiles and runs without any error.
  • The code coverage on your branch is 100%.
  • The documentation is updated if you added/changed a feature.

Please don't

  • The C++11 support varies between different compilers and versions. Please note the list of supported compilers. Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with #ifdefs or other means.
  • Please refrain from proposing changes that would break YAML specifications. If you propose a conformant extension of YAML to be supported by the library, please motivate this extension.
  • Please do not open pull requests that address multiple issues.

@fktn-k fktn-k added the documentation Improvements or additions to documentation label Dec 17, 2024
@fktn-k fktn-k added this to the Release v0.4.1 milestone Dec 17, 2024
@fktn-k fktn-k self-assigned this Dec 17, 2024
Copy link

:octocat: Upload Coverage Event Notification

Coverage data has been uploaded for the commit d5007231e96ede91db74c32b4475feec8e210254.
You can download the artifact which contains the same file uploaded to the Coveralls and its HTML version.

Name fkYAML_coverage.pr445.zip
ID 2332537975
URL https://github.com/fktn-k/fkYAML/actions/runs/12375776060/artifacts/2332537975

@fktn-k fktn-k merged commit 4361556 into develop Dec 17, 2024
163 checks passed
@fktn-k fktn-k deleted the revise_api_references branch December 17, 2024 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant