https://prefect.io logo
Title
s

Sean Talia

04/06/2021, 2:27 PM
hey all, this morning some changes that I made to the
ShellTask
got released, but it looks like my docstring edits broke the way the documentation renders, as you can see here – is the issue that I needed to put the
Raises
block above the
Example
block in the docstring? thanks for your help! apologies if this is causing anyone any difficulty
👀 1
z

Zach Angell

04/06/2021, 2:41 PM
hey Sean - thanks for contributing! The issue might be putting the
Raises
block above
Example
, I'm taking a look now. You can also preview docs locally if you're interested in following along https://docs.prefect.io/core/development/documentation.html#previewing-docs-locally
switching the order of the two blocks seems to resolve the problem, I'll open up a PR
👍 1
thanks for calling this out!
s

Sean Talia

04/06/2021, 2:46 PM
well my apologies for not previewing the documentation while I was doing the development, it didn't have to come to this! 😪
😂 2
clearly i'm new to making open source contributions
z

Zach Angell

04/06/2021, 2:51 PM
haha no worries you're doing great, I would never have guessed that docstring would cause an issue 🤷