Fix docstring syntax of optional parameters

sglvladi / Sphinx-RTD-Tutorial

A tutorial on how to use Sphinx

37 stars 106 forks source link

Fix docstring syntax of optional parameters #10

Open timobrembeck opened 3 years ago

timobrembeck commented 3 years ago

I noticed a problem with the syntax of optional parameters (#9) and suggested to remove them from the tutorial. This PR does exactly that.

Since the html build was changed 3 years ago, I assume I don't have to update it as well, right?

Fixes #9

timobrembeck commented 1 year ago

@sglvladi Do you think this change makes sense, or should I close this PR? Please mark the repository as archived or put a disclaimer in the readme if you don't want people to contribute (anymore).