Doc: Fixing several small issues #6392
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
agoscinski
force-pushed
the
agoscinski-patch-1
branch
from
c9b59a3 to
353b5d1
Compare
The recursive workchain in code snippets can theoretically not run and is just confusing to have as an example for a user. It has been fixed by using different name for the inner workchain.
agoscinski
force-pushed
the
agoscinski-patch-1
branch
from
12e31e5 to
d16f6aa
Compare
agoscinski
commented
May 15, 2024
| @@ -1,4 +1,7 @@ | |||
| from aiida.engine import WorkChain, append_ | |||
| from aiida.plugins.factories import CalculationFactory | |||
|
|
|||
| SomeOtherWorkChain = CalculationFactory('some.module') | |||
There was a problem hiding this comment.
had to define this somewhere, because mypy was complaining
In the classes NodeCaching and ProcessNodeCaching the `is valid_cache` is a property. To not render it with method brackets we use now the :attr: sphinx directive in the.
|
I will keep this PR as draft, since I will probably stumble on more small issues in the doc that I can fix here to reduce overhead of review and PR creation. |
agoscinski
changed the title
sphuber
approved these changes
Jun 28, 2024
There was a problem hiding this comment.
Thanks @agoscinski since this has been open for a long time now and we are about to release, I am merging this.
mikibonacci
pushed a commit
to mikibonacci/aiida-core
that referenced
this pull request
Sep 3, 2024
The recursive workchain in code snippets can theoretically not run and is just confusing to have as an example for a user. It has been fixed by using different name for the inner workchain. In the classes `NodeCaching` and `ProcessNodeCaching` the `is valid_cache` is a property. To not render it with method brackets, the `:attr:` sphinx directive is used instead of `:meth:`.
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.
Recursive workchain in code snippets that can theoretically not run has been fixed by using different name for the inner workchain
(Sorry did create a branch on aiida-core by accident instead of doing it in my fork)