Tyooughtul opened a new pull request, #3381:
URL: https://github.com/apache/fory/pull/3381
…wn files
- add extract_cpp_doc_examples.py to extract C++ code blocks from markdown
- integrate doc tests into CI with --skip-doc-tests and --doc-tests-only
options
- fix documentation bugs discovered by tests:
- index.md: change class to struct for aggregate initialization
- field-configuration.md: fix smart pointer access using .get()
- add cpp/doc_tests/ to .gitignore
issue: #658
<!--
**Thanks for contributing to Apache Fory™.**
**If this is your first time opening a PR on fory, you can refer to
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).**
Contribution Checklist
- The **Apache Fory™** community has requirements on the naming of pr
titles. You can also find instructions in
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).
- Apache Fory™ has a strong focus on performance. If the PR you submit
will have an impact on performance, please benchmark it first and provide the
benchmark result here.
-->
## Why?
<!-- Describe the purpose of this PR. -->
Add automated testing for C++ code examples in documentation to ensure they
compile and run correctly.
## What does this PR do?
<!-- Describe the details of this PR. -->
- add extract_cpp_doc_examples.py to extract C++ code blocks from markdown
- integrate doc tests into CI with --skip-doc-tests and --doc-tests-only
options
- fix documentation bugs discovered by tests:
- index.md: change class to struct for aggregate initialization
- field-configuration.md: fix smart pointer access using .get()
- add cpp/doc_tests/ to .gitignore
## Related issues
- #658
<!--
Is there any related issue? If this PR closes them you say say fix/closes:
- #xxxx0
- #xxxx1
- Fixes #xxxx2
-->
- [ ] Does this PR introduce any public API change?
- [ ] Does this PR introduce any binary protocol compatibility change?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
