search

ScreenPyHQ / screenpy

Screenplay pattern base for Python automated UI test suites.
MIT License
27 stars 3 forks source link

Bad RST linkage on Silently #94

Closed MarcelWilson closed 11 months ago

MarcelWilson commented 1 year ago

I noticed the way Silently is displayed seems to be broken. https://screenpy-docs.readthedocs.io/en/latest/cookbook.html#using-silently

image
perrygoy commented 1 year ago

Sorry, i should have caught this one.

Silently isn't a function, it's a class, so it should be prefixed with :class: instead of :function:.

MarcelWilson commented 1 year ago

I thought so too, but technically it IS a function. https://github.com/ScreenPyHQ/screenpy/blob/7882861f40946814293ea3ff8f2bca9a9c31494e/screenpy/actions/silently.py#L119

perrygoy commented 1 year ago

Oh that's right! I forgot that this one is a weird one. :P

Then i'm guessing it's because it's :func: not :function:?

perrygoy commented 11 months ago

This looks like it's been fixed, thanks @MarcelWilson!