Improve docs of markers #17545
Improve docs of markers #17545
Conversation
| Return the transform to be applied to the `.Path` from | ||
| `MarkerStyle.get_path()`. |
There was a problem hiding this comment.
Shouldn't pydocstyle be complaining that the first line should only be one line, or do we have that turned off?
There was a problem hiding this comment.
That would be
D400 - First line should end with a period
We have currently deactivated that in .flake8 because we have a couple of docstrings that can't reasonably be cramped into 79 chars.
While it's good to keep the summary sentence short, personally, I don't see the point in stripping relevant information from the summary only to adhere to that limit. If you have an idea how to shorten the sentence meaningfully to a single line, that'd of course be welcome.
There was a problem hiding this comment.
Not sure about the transform ones, but the get_alt_path one could be written like get_path.
There was a problem hiding this comment.
get_alt_path updated. I have no good idea for wording of the transforms, so I'd leave them pointing to the paths.
timhoffm
force-pushed
the
doc-markerstyle
branch
2 times, most recently
from
bb0224a
to
3f4ca2e
Compare
PR Summary