Skip to content

Improve Rust documentation聽#384

Description

@felixhekhorn

more serious follow-up from #377

When convincing people to adopt PineAPPL (such as @samiyrj for https://arxiv.org/abs/2603.09646) the number of TODO is a bit embarrassing 馃檲 We were trying to copy yadism, but of course that only works up to a point ...

Image

(there and everywhere inside where it already says TODO); same holds for e.g. ConvType

However, unfortunately these are mostly new things in PineAPPL v1 so I'm not 100% firm myself on what they exactly mean ... e.g. what does the argument of Kinematics::Scale refer to? or ScaleFuncForm::Scale?

Activity

  1. Radonirinaunimi commented on Mar 20, 2026

    @Radonirinaunimi
    Member

    That's a really good point and we should really put some efforts in addressing this. I will try to improve this in the next days.

  2. cschwan commented on Mar 21, 2026

    @cschwan
    Contributor

    This was postponed as the implementation of version-1.0 functionality was prioritized; that being done we should really fill in the blanks, @Radonirinaunimi we should start with the types that are needed for Grid::new.

    @felixhekhorn: I added some preliminary documentation in commit 7c03a55.

  3. linked a pull request that will close this issueFinalize Documentation #394on Mar 31, 2026
  4. added this to the v1.4 milestone on Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions