lucasfang opened a new pull request, #521:
URL: https://github.com/apache/paimon-cpp/pull/521

   ### Purpose
   
   Linked issue: None.
   
   Readers copying the BLOB schema example cannot compile it against installed 
Paimon headers because it uses an internal Arrow conversion macro. The example 
now checks the Arrow result explicitly and uses public APIs only.
   
   Correct two snapshot-related descriptions:
   - Explain that `$files` and `$manifests` honor `scan.snapshot-id`, default 
to the latest snapshot, and fail if the requested snapshot does not exist.
   - Distinguish direct file-system publication, publication through a 
version-managed catalog, and REST request preparation. Rename and `LATEST` 
updates apply to direct file-system commits; request preparation does not 
publish a snapshot. Also describe metadata retention when the publication 
outcome is uncertain.
   
   ### Tests
   
   - Changed-file pre-commit checks passed, including spelling, Sphinx lint, 
whitespace, EOF and large-file checks.
   - Regenerated Doxygen XML from the current public headers and built the 
complete Sphinx HTML documentation with warnings treated as errors.
   - Extracted the BLOB example into a `Status`-returning translation unit and 
compiled it with only public Paimon headers and Arrow headers. The original 
example fails because the internal macro is unavailable; the corrected example 
passes.
   - `git diff --check` passed.
   
   Commands:
   
   ```bash
   pre-commit run --files docs/source/user_guide/write.rst 
docs/source/user_guide/system_tables.rst docs/source/user_guide/commit.rst
   (cd apidoc && OUTPUT_DIRECTORY=/tmp/paimon-docs-pr-doxygen doxygen Doxyfile)
   PAIMON_CPP_DOXYGEN_XML=/tmp/paimon-docs-pr-doxygen/xml sphinx-build -b html 
-W --keep-going -j 4 docs/source /tmp/paimon-docs-pr-html
   # Extracted BLOB example supplied on stdin:
   g++ -std=c++17 -Wall -Werror -fsyntax-only -Iinclude -isystem 
build/arrow_ep-install/include -x c++ -
   git diff --check
   ```
   
   No unit or integration tests were added or run: only documentation and its 
example change.
   
   ### API and Format
   
   No public API, storage format, protocol or runtime behavior changes.
   
   ### Documentation
   
   Update the write, system-table and commit guides to match existing 
implementation behavior. No new feature is introduced.
   
   ### Generative AI tooling
   
   Generated-by: OpenAI Codex (codex-cli 0.166.0)
   
   


-- 
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]

Reply via email to