You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/05/04 12:18:47 UTC

[GitHub] [arrow] kszucs opened a new pull request #10241: ARROW-12645: [Python] Fix numpydoc validation

kszucs opened a new pull request #10241:
URL: https://github.com/apache/arrow/pull/10241


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow] jorisvandenbossche commented on pull request #10241: ARROW-12645: [Python] Fix numpydoc validation

Posted by GitBox <gi...@apache.org>.
jorisvandenbossche commented on pull request #10241:
URL: https://github.com/apache/arrow/pull/10241#issuecomment-832462864


   Ensuring that all keywords are documented sounds useful to check for. So indeed, if there is one of the validation chekcs we find useful and is passing, we could at that point add it to CI to keep it passing?
   
   Looking at the actual output above:
   
   > pyarrow.parquet.write_table
   PR01: Parameters {'use_compliant_nested_type', 'where', 'row_group_size', 'use_byte_stream_split', 'compression_level', '**kwargs'} not documented
   
   It seems there are some false positives for this check. In this case, all those keywords (except for `**kwargs`) are actually documented, but they are missing a space before the colon (`keyword: type` instead of `keyword : type`). Numpydoc, which is used for the validation, is picky about this. But the doc build itself looks fine, for which we use sphinx.ext.napoleon.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow] kszucs edited a comment on pull request #10241: ARROW-12645: [Python] Fix numpydoc validation

Posted by GitBox <gi...@apache.org>.
kszucs edited a comment on pull request #10241:
URL: https://github.com/apache/arrow/pull/10241#issuecomment-831899996


   @jorisvandenbossche any ideas how could we incorporate the numpydoc validations in our CI? We could incrementally enable more and more checks, though we have many docstring violations. 
   
   cc @pitrou you may be interested as well.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow] kszucs commented on pull request #10241: ARROW-12645: [Python] Fix numpydoc validation

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #10241:
URL: https://github.com/apache/arrow/pull/10241#issuecomment-834155999


   We can do a mass update for `PR10` errors before enabling `PR1` on CI:
   
   ```
   pyarrow.parquet.write_table
   GL02: Closing quotes should be placed in the line after the last text in the docstring (do not close the quotes in the same line as the text, or leave a blank line between the last text and the quotes)
   GL03: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
   PR01: Parameters {'use_byte_stream_split', 'compression_level', 'where', 'use_compliant_nested_type', 'row_group_size', '**kwargs'} not documented
   PR02: Unknown parameters {'row_group_size: int', 'use_compliant_nested_type: bool', 'use_byte_stream_split: bool or list', 'compression_level: int or dict', 'where: string or pyarrow.NativeFile', 'default None', 'default False'}
   PR07: Parameter "table" has no description
   PR10: Parameter "where" requires a space before the colon separating the parameter name and type
   PR07: Parameter "where: string or pyarrow.NativeFile" has no description
   PR10: Parameter "row_group_size" requires a space before the colon separating the parameter name and type
   PR09: Parameter "row_group_size: int" description should finish with "."
   PR09: Parameter "coerce_timestamps" description should finish with "."
   PR10: Parameter "compression_level" requires a space before the colon separating the parameter name and type
   PR04: Parameter "default None" has no type
   PR10: Parameter "use_byte_stream_split" requires a space before the colon separating the parameter name and type
   PR04: Parameter "default False" has no type
   PR10: Parameter "use_compliant_nested_type" requires a space before the colon separating the parameter name and type
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow] kszucs closed pull request #10241: ARROW-12645: [Python] Fix numpydoc validation

Posted by GitBox <gi...@apache.org>.
kszucs closed pull request #10241:
URL: https://github.com/apache/arrow/pull/10241


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow] kszucs commented on pull request #10241: ARROW-12645: [Python] Fix numpydoc validation

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #10241:
URL: https://github.com/apache/arrow/pull/10241#issuecomment-831899996


   @jorisvandenbossche any ides how could we incorporate the numpydoc validations in our CI? We could incrementally enable more and more checks, though we have many docstring violations. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow] github-actions[bot] commented on pull request #10241: ARROW-12645: [Python] Fix numpydoc validation

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #10241:
URL: https://github.com/apache/arrow/pull/10241#issuecomment-831898035


   https://issues.apache.org/jira/browse/ARROW-12645


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow] kszucs commented on pull request #10241: ARROW-12645: [Python] Fix numpydoc validation

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #10241:
URL: https://github.com/apache/arrow/pull/10241#issuecomment-836892435


   Created a jira where we can figure out a way to incorporate numpydoc in the CI checks https://issues.apache.org/jira/browse/ARROW-12718


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [arrow] kszucs edited a comment on pull request #10241: ARROW-12645: [Python] Fix numpydoc validation

Posted by GitBox <gi...@apache.org>.
kszucs edited a comment on pull request #10241:
URL: https://github.com/apache/arrow/pull/10241#issuecomment-831899996


   @jorisvandenbossche any ideas how could we incorporate the numpydoc validations in our CI? We could incrementally enable more and more checks, though we have many docstring violations. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org