Docstring parsing 'Args' vs 'Arguments'

canonical / charmhub.io

GNU General Public License v3.0

9 stars 22 forks source link

Docstring parsing 'Args' vs 'Arguments' #1169

Open jnsgruk opened 2 years ago

jnsgruk commented 2 years ago

Related to #1156

At the moment, the docstring parser for Charm libraries seems to only parse the term Arguments: in a docstring, my understanding is that the Google Style permits Args: too. Could we adjust so that both work and display arguments correctly?

Example of broken-ness in attached image :) Screenshot-20211029113357-952x280

jnsgruk commented 2 years ago

I should note, I think the docstring is actually correct in this case:

Screenshot-20211029113458-874x465