Repository navigation
[rfile] Add python documentation - #23816
Draft
muntasir-396 wants to merge 1 commit into
Draft
muntasir-396 wants to merge 1 commit into
muntasir-396 wants to merge 1 commit into
Conversation
Document ROOT::Experimental::RFile pythonizations and add Doxygen commands across docstrings. Create a dedicated Doxygen group and documentation page for RFile in the Python interface, and link it from the Python interface index. Fixes root-project#22541
Member
|
Is this complementary to #23633 ? |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses #22541 by providing documentation for
ROOT::Experimental::RFilein Python:RFileunder\pythondoc ROOT::Experimental::RFilein_rfile.py(replacing the previousTODOplaceholder).\ingroup Py_RFile,\brief,\param,\return,\exception) across docstrings in_rfile.py.bindings/pyroot/pythonizations/python/ROOT/_pythonization/rfile.md(\defgroup Py_RFile RFileunder\ingroup Python).RFilePython interface inbindings/pyroot/pythonizations/doc/index.mdand added anRFileexample to the quickstart section.Fixes #22541
AI-assisted coding disclosure
The initial draft of the documentation and docstrings was prepared with an LLM coding assistant and thoroughly reviewed, tested, and validated by the author.