Remove unnecessary paths from Sphinx directives.

ScreenPyHQ / screenpy

Screenplay pattern base for Python automated UI test suites.

MIT License

27 stars 3 forks source link

Remove unnecessary paths from Sphinx directives. #132

Closed perrygoy closed 4 months ago

perrygoy commented 6 months ago

I just found out yesterday that when you're in the class, you don't need to supply the path to the method! You can just do

:meth:`methodname`

Life-changing. But more life-changing is our decision to document aliases differently, mentioning them in the base class and skipping their documentation in the ... documentation. This PR does both of those things!

bandophahita commented 6 months ago

Looks like mypy doesn't currently support aliases this way.

https://github.com/python/mypy/issues/6700