Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings

2020-09-25 Thread John Snow
On 9/25/20 3:49 AM, Markus Armbruster wrote: John Snow writes: On 9/24/20 11:06 AM, Markus Armbruster wrote: John Snow writes: On 9/17/20 3:14 PM, Eduardo Habkost wrote: On Thu, Sep 17, 2020 at 02:44:53PM -0400, John Snow wrote: [...] Having said this, I have not found any tool to date t

Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings

2020-09-25 Thread Markus Armbruster
John Snow writes: > On 9/24/20 11:06 AM, Markus Armbruster wrote: >> John Snow writes: >> >>> On 9/17/20 3:14 PM, Eduardo Habkost wrote: On Thu, Sep 17, 2020 at 02:44:53PM -0400, John Snow wrote: [...] > Having said this, I have not found any tool to date that actually *checks* >>

Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings

2020-09-24 Thread John Snow
On 9/24/20 11:06 AM, Markus Armbruster wrote: John Snow writes: On 9/17/20 3:14 PM, Eduardo Habkost wrote: On Thu, Sep 17, 2020 at 02:44:53PM -0400, John Snow wrote: [...] Having said this, I have not found any tool to date that actually *checks* these comments for consistency. The pycharm I

Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings

2020-09-24 Thread Markus Armbruster
John Snow writes: > On 9/17/20 3:14 PM, Eduardo Habkost wrote: >> On Thu, Sep 17, 2020 at 02:44:53PM -0400, John Snow wrote: >> [...] >>> Having said this, I have not found any tool to date that actually *checks* >>> these comments for consistency. The pycharm IDE interactively highlights >>> the

Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings

2020-09-17 Thread John Snow
On 9/17/20 3:14 PM, Eduardo Habkost wrote: On Thu, Sep 17, 2020 at 02:44:53PM -0400, John Snow wrote: [...] Having said this, I have not found any tool to date that actually *checks* these comments for consistency. The pycharm IDE interactively highlights them when it senses that you have made a

Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings

2020-09-17 Thread Eduardo Habkost
On Thu, Sep 17, 2020 at 02:44:53PM -0400, John Snow wrote: [...] > Having said this, I have not found any tool to date that actually *checks* > these comments for consistency. The pycharm IDE interactively highlights > them when it senses that you have made a mistake, but that cannot be worked > in

Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings

2020-09-17 Thread John Snow
On 9/17/20 10:37 AM, Markus Armbruster wrote: John Snow writes: As docstrings, they'll show up in documentation and IDE help. Signed-off-by: John Snow --- scripts/qapi/common.py | 50 ++ 1 file changed, 36 insertions(+), 14 deletions(-) diff --git

Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings

2020-09-17 Thread Markus Armbruster
John Snow writes: > As docstrings, they'll show up in documentation and IDE help. > > Signed-off-by: John Snow > --- > scripts/qapi/common.py | 50 ++ > 1 file changed, 36 insertions(+), 14 deletions(-) > > diff --git a/scripts/qapi/common.py b/scripts/qa

[PATCH 14/37] qapi/common.py: Move comments into docstrings

2020-09-15 Thread John Snow
As docstrings, they'll show up in documentation and IDE help. Signed-off-by: John Snow --- scripts/qapi/common.py | 50 ++ 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py index af01348b35..38d