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

Documentation - first batch #26

Merged
merged 22 commits into from
May 19, 2020
Merged

Documentation - first batch #26

merged 22 commits into from
May 19, 2020

Conversation

alecandido
Copy link
Member

@alecandido alecandido commented Apr 2, 2020

  • Next thing to do: label each formula with reference, in the code docstring.

Source

Module to document:

  • runner
  • structure_functions
  • structure_functions/EvaluatedStructureFunctions
  • structure_functions/{F2,FL}
  • structure_functions/convolution

Test

Test collections:

  • against_apfel
  • convolution

Sphinx

Documentation structure:

  • home
  • variable definition
  • room for long module descriptions

More & misc

...

@alecandido alecandido linked an issue Apr 2, 2020 that may be closed by this pull request
6 tasks
@alecandido alecandido added the documentation Improvements or additions to documentation label Apr 2, 2020
@alecandido
Copy link
Member Author

alecandido commented Apr 10, 2020

  • Find a way with graphviz to put edges without moving positions of nodes (F2-FL same level of StructureFunction, but they inherit from it)
  • make clear the interface level correspond to the underlying implementation
    • at the level of EvaluatedStructureFunctions the kinematics is known, so it is possible to compute the coefficient functions explicitly, and it is done, but it is never exposed, since Runner interacts through StructureFunctions instead
  • make sure that the edges style is consistent (inheritance, interface, member, ...)

@alecandido alecandido closed this Apr 21, 2020
@alecandido alecandido deleted the docs1 branch April 21, 2020 09:29
@alecandido alecandido restored the docs1 branch April 21, 2020 09:31
@alecandido alecandido reopened this Apr 21, 2020
@alecandido alecandido closed this Apr 24, 2020
@alecandido alecandido reopened this Apr 24, 2020
@alecandido
Copy link
Member Author

alecandido commented May 19, 2020

The current branch was outdated, now is synced with master.

However, since it is better to break also documentation upgrades in small focused PRs, I am going to merge this one.

The achieved goals are to almost completely document convolution API (missing a theoretical part on how the integration is performed) and ESF's one.

@alecandido alecandido merged commit 9a1d94b into master May 19, 2020
@alecandido alecandido deleted the docs1 branch May 19, 2020 12:22
@alecandido alecandido mentioned this pull request May 19, 2020
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

NLO documentation
1 participant