Add colons between parameter names and types in docs

[mrotondo]

This addresses the change in the doc generation parser which was swallowing the colon. Fixes #468

[Mr0grog]

Well, I feel really bad about this, but it turns out this is not a good fix for the problem. That’s not your fault, though! The issue was incorrectly described in #468. When reviewing this, I noticed it didn’t quite fix the whole problem and wound up going on a deep dive to figure out what was really happening.

As a result, I added a deeper, correct analysis as a comment on the original issue: #468 (comment)

Not sure if you want to keep working on the issue and whether you want to keep working on this PR or just start over. Let me know.

[mrotondo]

Thanks for digging into this! I'll stick with the issue, the actual fix will be more satisfying than this commit, which definitely felt arbitrary!

[mrotondo]

This PR now adds the custom styling which properly causes API parameters to have ": " inserted before their type. In #468, you also mention adding "nicer styling for field lists", is there a particular aspect of the current (definitely very plain) list formatting that you think should be improved?

[Mr0grog]

I don’t think I had any particularly strong ideas here. The biggest thing for me was perhaps to visually distinguish the headings (e.g. “Parameters,” “Returns,” etc.) in a clearer way from the actual list items, since they both have the same styling right now.

You could also try matching it up with the old styling (where those headings were to the left of the list of parameters/return values/etc). CSS grid would probably be the easiest way to do that (just spitballing here, not really well tested):

.rst-content .field-list.simple {
  display: grid;
  grid-template-columns: 10em 1fr;
}

.rst-content .field-list.simple > dt {
  background: transparent;
  border: none;
  display: block;
}

But you could also just leave it for now, and I or someone else with stronger layout ideas could come back around later to improve.

[mrotondo]

I'm gonna leave this alone for now, since it's more legible than it was and the class constructor field lists don't have quite the same css structure as the method field lists. This should be good to go

[Mr0grog]

Great, merging this, then. 😄