Update documentation #24
Open
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
jessica-mitchell
suggested changes
Dec 7, 2023
doc/overview.rst
Outdated
| .. attention:: | ||
|
|
||
| Please note that the code in this repository is compatible with the latest | ||
| NEST version only; in particular the git "master" branch on |
There was a problem hiding this comment.
Is this accurate? Is the extension module really up-to-date to master and will always be?
There was a problem hiding this comment.
That is, at least, the theory :)
There was a problem hiding this comment.
This statement is already mentioned in extension_modules.rst. Is this required here again?
There was a problem hiding this comment.
I would like to keep this as a highlight in README.rst as it's quite important to note.
pnbabu
requested changes
Dec 14, 2023
doc/overview.rst
Outdated
| .. attention:: | ||
|
|
||
| Please note that the code in this repository is compatible with the latest | ||
| NEST version only; in particular the git "master" branch on |
There was a problem hiding this comment.
This statement is already mentioned in extension_modules.rst. Is this required here again?
clinssen
commented
Jan 8, 2024
clinssen
commented
Jan 8, 2024
Co-authored-by: Pooja Babu <75320801+pnbabu@users.noreply.github.com> Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
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.
build.shscript in favour of better installation instructions on RtD and contents moved to GitHub workflow file