Skip to content

Finalize Documentation#394

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

Finalize Documentation#394
Radonirinaunimi wants to merge 5 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 list of codes that use PineAPPL


/// Upgrades the internal data structures to their latest versions.
pub fn upgrade(&mut self) {}
pub const fn upgrade(&mut self) {}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While the current implementation surely calls for const, it's possible that future implementation will be more complicated and thus will have to remove const, which would constitute a breaking change, I suppose.

/// Per-dimension node coordinates (scales, x values, etc.).
#[new]
#[must_use]
#[allow(clippy::needless_pass_by_value)]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't it be better to fix the actual warning instead of disabling it?

/// # Example
///
/// In the case of DrellYan, there are the following orders:
/// In the case of Drell-Yan, there are the following orders:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the problem with en-dashes here and below?

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