docs: Added description of how to add new algorithm #1599
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
jahreda
reviewed
Oct 14, 2022
benjaminhuth
requested changes
Oct 17, 2022
There was a problem hiding this comment.
Thank you for setting this up! I've also made a few comments, and I have also some general remarks:
- On the last docathon we said that we want to move from
*.rstto the myst-markdown format. I think this is not super crucial, but it also should not be difficult to change. There is also a cheatsheet regarding this: https://acts.readthedocs.io/en/latest/contribution/documentation_cheatsheet.html - Maybe it could be good to also mention the Readers and Writers as kind of IO-algorithms in a short section (so basically only that this exists).
benjaminhuth
requested changes
Oct 25, 2022
|
@asalzburger - can you please have a look |
asalzburger
approved these changes
Nov 22, 2022
|
@benjaminhuth are you happy with the changes? |
|
@asalzburger @benjaminhuth - can we get this in? |
benjaminhuth
approved these changes
Dec 2, 2022
pbutti
pushed a commit
to pbutti/acts
that referenced
this pull request
Dec 13, 2022
This PR adds detailed doc on how to add a new ACTS example algorithm.
CarloVarni
pushed a commit
to CarloVarni/acts
that referenced
this pull request
Dec 22, 2022
This PR adds detailed doc on how to add a new ACTS example algorithm.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds detailed doc on how to add a new ACTS example algorithm.