DM-27490: Add support for collection docstrings. #430
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
timj
approved these changes
Nov 10, 2020
| name : `str` | ||
| Name of the collection. | ||
| docs : `str`, optional | ||
| Docstring for the collection with the given name. |
There was a problem hiding this comment.
If you set doc to None here does it remove the existing docstring? Maybe state that this value overwrites a previous value?
There was a problem hiding this comment.
It should remove the existing docstring. I'll update the docstring and add a test to make sure it's not lying.
TallJimbo
force-pushed
the
tickets/DM-27490
branch
from
d9d5c25
to
93f6cfc
Compare
TallJimbo
force-pushed
the
tickets/DM-27490
branch
from
93f6cfc
to
a9f5a45
Compare
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.
No description provided.