Update ParameterHandler.add_parameter docstring

[mattwthompson]

Small fix (#606) that I didn't get to earlier.

• Tag issue being addressed
• Add tests
• Update docstrings/documentation, if applicable
• Lint codebase
• Update changelog

[codecov]

Codecov Report

Merging #970 (a58421a) into master (600ebb3) will not change coverage.
The diff coverage is n/a.

[j-wags]

Looks great. Thanks!

[Yoshanuikabundi]

Hey @mattwthompson! Sorry I didn't get to review this before it merged --- looks like you're writing in Markdown, and unfortunately the docstrings are still parsed as ReST, so we've got things like italics where you meant code and a broken link.

Converting the existing docstrings to Markdown is obviously a big job, and the tooling for parsing doesn't exist yet anyway unless we want to give up things like cross references or ditch Sphinx altogether. So we're probably stuck with ReST for a little while yet.

[mattwthompson]

Hmm, I must not have looked at the actual source before merging:

I think in this case the only differences are single to double backticks and fixing the link?

[Yoshanuikabundi]

I think so! I had a good look into enabling markdown for docstrings yesterday and the support really isn't there. Sorry :(