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 for Collective Effects #599

Merged
merged 16 commits into from
May 31, 2023
Merged

Documentation for Collective Effects #599

merged 16 commits into from
May 31, 2023

Conversation

lcarver
Copy link
Contributor

@lcarver lcarver commented May 5, 2023

Unable to check the formula as it doesn't display in the github page viewer. Nonetheless it can still be reviewed, and I encourage reviewers to propose or make modifications as they see fit.

@lfarv
Copy link
Contributor

lfarv commented May 17, 2023

Unable to check the formula as it doesn't display in the github page viewer.

You can check the result here.

Good for me, except that there is no syntax highlighting in code blocks. Maybe use .. code:: python instead of .. code:: ipython3

docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
@lfarv
Copy link
Contributor

lfarv commented May 17, 2023

This is very nice !

A detail: could you put cross-reference links for the end notes, and also possibly links to the reference papers ? Apparently they are freely available:

@swhite2401
Copy link
Contributor

This look fine for me too, adding links as @lfarv mentioned would be nice indeed

docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
@lcarver
Copy link
Contributor Author

lcarver commented May 24, 2023

All comments so far have been implemented. Simone only read half of the document so I wait a bit longer.

docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Outdated Show resolved Hide resolved
docs/p/howto/Collective.rst Show resolved Hide resolved
@lcarver
Copy link
Contributor Author

lcarver commented May 31, 2023

ready for merge, needs final approval

@lcarver lcarver merged commit 8944339 into master May 31, 2023
31 checks passed
@lcarver lcarver deleted the collective_docs branch May 31, 2023 09:21
@lfarv lfarv mentioned this pull request Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants