Docstring grammar fix #1583
Merged
Docstring grammar fix #1583
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
An insignificant fix to a docstring with the ulterior motive of triggering a new Read the Docs build
mdickinson
commented
Oct 12, 2021
| @@ -197,7 +197,7 @@ def parse(text): | |||
|
|
|||
| @lru_cache(maxsize=expression_module._OBSERVER_EXPRESSION_CACHE_MAXSIZE) | |||
| def compile_str(text): | |||
| """ Compile a mini-language string to a list of ObserverGraphs. | |||
| """ Compile a mini-language string to a list of ObserverGraph objects. | |||
There was a problem hiding this comment.
To motivate the fix itself: I do often do a regex search for patterns like "\bsome-identifier\b", and this sort of pluralization foils that kind of search. So it's something I try to avoid.
|
I was able to force a rebuild of "latest" for Read the Docs, so the ulterior motive no longer applies. We might as well merge this anyway, though. |
rahulporuri
approved these changes
Oct 12, 2021
|
Just to confirm, automated builds for Read the Docs seem to be working fine: https://traits.readthedocs.io/en/latest/traits_api_reference/traits.observation.html?highlight=compile_str#traits.observation.parsing.compile_str |
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.
An insignificant fix to a docstring with the ulterior motive of triggering a new Read the Docs build