Skip to content
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

[RF] Documentation of RooAbsReal::getValues is broken #9523

Closed
hageboeck opened this issue Jan 10, 2022 · 4 comments
Closed

[RF] Documentation of RooAbsReal::getValues is broken #9523

hageboeck opened this issue Jan 10, 2022 · 4 comments

Comments

@hageboeck
Copy link
Member

hageboeck commented Jan 10, 2022

  • A rebase or similar apparently cut the documentation in two, and a stray sentence now leads the documentation of the second overload.
  • The first overload has no documentation at all ...

Please make it a habit immediately write a good docstring in the same commit where the interface is fixed defined.

/// \deprecated getValBatch() has been removed in favour of the faster getValues(). If your code is affected
/// by this change, please consult the release notes for ROOT 6.24 for guidance on how to make this transition.
/// https://root.cern/doc/v624/release-notes.html
#ifndef R__MACOSX
virtual RooSpan<const double> getValBatch(std::size_t /*begin*/, std::size_t /*maxSize*/, const RooArgSet* /*normSet*/ = nullptr) = delete;
#else
//AppleClang in MacOS10.14 has a linker bug and fails to link programs that create objects of classes containing virtual deleted methods.
//This can be safely deleted when MacOS10.14 is no longer supported by ROOT. See https://reviews.llvm.org/D37830
virtual RooSpan<const double> getValBatch(std::size_t /*begin*/, std::size_t /*maxSize*/, const RooArgSet* /*normSet*/ = nullptr) final {
throw std::logic_error("Deprecated getValBatch() has been removed in favour of the faster getValues(). If your code is affected by this change, please consult the release notes for ROOT 6.24 for guidance on how to make this transition. https://root.cern/doc/v624/release-notes.html");
}
#endif
/// by this change, please consult the release notes for ROOT 6.24 for guidance on how to make this transition.
virtual RooSpan<const double> getValues(RooBatchCompute::RunContext& evalData, const RooArgSet* normSet = nullptr) const;

https://root.cern.ch/doc/master/classRooAbsReal.html#a3f4185c14daa089c29ae3ba1e90b5235

@guitargeek
Copy link
Contributor

Removed from the milestone because this is now superseded by the actual PRs that are added to the milestone instead.

guitargeek added a commit to guitargeek/root that referenced this issue Feb 3, 2022
guitargeek added a commit to guitargeek/root that referenced this issue Feb 3, 2022
guitargeek added a commit to guitargeek/root that referenced this issue Feb 3, 2022
guitargeek added a commit that referenced this issue Feb 3, 2022
@github-actions
Copy link

github-actions bot commented Feb 4, 2022

Hi @guitargeek,

It appears this issue is closed, but wasn't yet added to a project. Please add upcoming versions that will include the fix, or 'not applicable' otherwise.

Sincerely,
🤖

2 similar comments
@github-actions
Copy link

github-actions bot commented Feb 7, 2022

Hi @guitargeek,

It appears this issue is closed, but wasn't yet added to a project. Please add upcoming versions that will include the fix, or 'not applicable' otherwise.

Sincerely,
🤖

@github-actions
Copy link

github-actions bot commented Feb 8, 2022

Hi @guitargeek,

It appears this issue is closed, but wasn't yet added to a project. Please add upcoming versions that will include the fix, or 'not applicable' otherwise.

Sincerely,
🤖

@guitargeek guitargeek added this to Issues in Fixed in 6.26/00 via automation Feb 8, 2022
@guitargeek guitargeek changed the title Documentation of RooAbsReal::getValues is broken [RF] Documentation of RooAbsReal::getValues is broken Jun 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

No branches or pull requests

2 participants