Removing inherited docstrings from Docs #628
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
|
Question Time: Which should I do?
|
ntouran
approved these changes
Apr 19, 2022
There was a problem hiding this comment.
I think you should add a short comment to this explaining why we turned that off. Git blame may be useful but it's probably worth a comment so someone else doesn't just turn it back on.
Also, I think opening a ticket on yamlize would be useful, as I expect other uses of the lib will run into a similar issue and they're more likely to find it there than here.
|
Okay, the problem is generally fixed in the docs except for subclasses of |
drewj-usnctech
added a commit
to drewj-usnctech/armi
that referenced
this pull request
Apr 20, 2022
…efine-system-builders * terrapower/master: (24 commits) Update docstring formatting in `getPotentialParentFromSettingValue` (terrapower#627) Removing inherited docstrings from Docs (terrapower#628) Removing bare "import armi" statements (terrapower#626) Fixing assembly number issue in DB Load (terrapower#615) Making the app version more available (terrapower#624) Adding MPI tests to code coverage (terrapower#625) Removing support for XML Settings files (terrapower#612) Minor language cleanup in new standards and practices. (terrapower#610) remove extraneous `mpicov` arg from tox.ini envlist (terrapower#604) Swap flux param (terrapower#605) Fixing _fluxSwapParam for NumPy arrays (terrapower#607) Unshaped component (terrapower#600) Fixing docstring (terrapower#601) Adding options to settings report (terrapower#598) Adding coding standards and practices to Docs (terrapower#597) Removing defunct code from HistoryTrackerInterface (terrapower#594) Fix to a bug where an ARMI application could not call (terrapower#593) Tracking ARMI Requirements (terrapower#590) Remove PyYaml Dependency (terrapower#586) Filling out code coverage for entry points (terrapower#587) ...
scottyak
pushed a commit
to scottyak/armi
that referenced
this pull request
Oct 27, 2022
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.
Description
It has been noted that our auto-docs use super class docstrings if the class doesn't have a docstring:
#423
That's no good, so this PR fixes that.
Caveat: I was not able to fix this problem for
yamlizeclasses for some reason. For instance, radialMeshPoints are a subclass ofyamlize.Attributes. And the only solution I have found for this is I can completely remove theradialMeshPointsmember from theAssemblyBlueprintdoc entirely. But I have not found a way to remove the inherited docs fromyamlizesubclasses.Checklist
If user exposed functionality was added/changed:
docfolder.