Skip to content

Clarify type restrictions of get_value() & get_value_ref() APIs #424

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 3 commits into from
Nov 16, 2024

Conversation

fktn-k
Copy link
Owner

@fktn-k fktn-k commented Nov 16, 2024

Although get_value() calls with a reference, pointer, or C-style array type are not supported, but actual attempts of such calls emit user-unfriendly compile error messages.
So, in this PR, static_asserts have been added to detect those types and emit an error message which clearly states they are unsupported.
The documentation pages for get_value() and get_value_ref() APIs have also been updated to clarify type restrictions.


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 improvement refactoring or optimization without public API changes label Nov 16, 2024
@fktn-k fktn-k added this to the Release v0.3.14 milestone Nov 16, 2024
@fktn-k fktn-k self-assigned this Nov 16, 2024
Copy link

:octocat: Upload Coverage Event Notification

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

Name fkYAML_coverage.pr424.zip
ID 2196006579
URL https://github.com/fktn-k/fkYAML/actions/runs/11867168871/artifacts/2196006579

@fktn-k fktn-k changed the title Clarify type restriction of get_value() & get_value_ref() APIs Clarify type restrictions of get_value() & get_value_ref() APIs Nov 16, 2024
@fktn-k fktn-k merged commit cf79a86 into develop Nov 16, 2024
171 checks passed
@fktn-k fktn-k deleted the clarify_type_restriction_of_getter_apis branch November 16, 2024 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement refactoring or optimization without public API changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant