TRestAnalysisTree. Reviewing documentation #343
Merged
Conversation
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
jgalan
commented
Dec 7, 2022
jgalan
commented
Dec 7, 2022
| /// variables by invoking the `SetObservableValue()` method and then | ||
| /// TRestAnalysisTree::Fill() to generate a new entry inside the tree. | ||
| /// The code will be simplified while sacrificing a little performance. We can use | ||
| /// temporary variable to set observable value directly. We can focus on the analysis |
Member
Author
There was a problem hiding this comment.
I do not catch the meaning of these 2 last sentences.
In one hand what we do is to encapsulate the use of the tree through the method SetObservableValue so that the user does not need to be playing around with direct variable generation and branch address creation. Perhaps is something like that we should say here?
Member
There was a problem hiding this comment.
what we do is to encapsulate the use of the tree through the method SetObservableValue so that the user does not need to be playing around with direct variable generation and branch address creation
Exactly. That shall be one of the selling point of TRestAnalysisTree. We can clarify it in the text.
nkx111
approved these changes
Jan 12, 2023
jgalan
commented
Jan 12, 2023
Member
Author
|
Please, approve! |
for more information, see https://pre-commit.ci
juanangp
approved these changes
Mar 28, 2023
jgalan
added a commit
that referenced
this pull request
May 3, 2023
…tree_documentation"" This reverts commit 3394b28.
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.
The TRestAnalysisTree, together with the TRestMetadata class are one of the most visited pages on our API documentation pages. Thus, I took a bit of time to review.
Still, it might require your attention to improve the description of the class.