Skip to content

Finalize Documentation#394

Open
Radonirinaunimi wants to merge 10 commits intomasterfrom
finalize-docs
Open

Finalize Documentation#394
Radonirinaunimi wants to merge 10 commits intomasterfrom
finalize-docs

Conversation

@Radonirinaunimi
Copy link
Copy Markdown
Member

@Radonirinaunimi Radonirinaunimi commented Mar 31, 2026

This PR aims to address once and for all the issues regarding missing/unclear documentations summarized in #393.

Remaining Todo:

  • fix upstream Python documentation that does not show some modules
  • document the various codes that use PineAPPL

Comment thread pineappl/src/grid.rs Outdated
Comment thread pineappl_py/src/subgrid.rs
Comment thread pineappl/src/boc.rs Outdated
Comment thread pineappl/src/boc.rs Outdated
@Radonirinaunimi
Copy link
Copy Markdown
Member Author

The final piece missing in this PR which concerns the list of programs that use PineAPPL is added in b35684a. I used an itemized list before and didn't look good (at least to my taste) and hence why I went for the table. Please have a look.

@cschwan
Copy link
Copy Markdown
Contributor

cschwan commented May 9, 2026

I think I also like the table better - I tried a list myself.

  1. Should we really mention APPLgrid and fastNLO? Technically speaking we're using them, not the other way around.
  2. APFEL++ and EKO should get links to their homepages.
  3. I'm not sure I like the intermediate headings. If you get rid of them,
    • try to use markdown tables
    • sort the entries alphabetically and
    • merge the PineAPFEL entry.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants