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 2023/01/06 00:37:13 UTC
[GitHub] [arrow] amoeba opened a new pull request, #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
amoeba opened a new pull request, #15214:
URL: https://github.com/apache/arrow/pull/15214
This adds the numpydoc checks GL10, PR04, PR05, RT03, and YD01 to CI and fixes the associated issues in docstrings.
These checks are:
- GL10: reST directives {directives} must be followed by two colons
- PR04: Parameter "{param_name}" has no type
- PR05: Parameter "{param_name}" type should not finish with "."
- RT03: Return value has no description
- YD01: No Yields section found
https://numpydoc.readthedocs.io/en/latest/validation.html
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amoeba commented on a diff in pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
amoeba commented on code in PR #15214:
URL: https://github.com/apache/arrow/pull/15214#discussion_r1063805052
##########
python/pyarrow/_dataset.pyx:
##########
@@ -532,12 +532,12 @@ cdef class InMemoryDataset(Dataset):
Parameters
----------
- source : The data for this dataset.
+ source : The data for this dataset
Review Comment:
Good eye. Numpydoc catches the first issue (the period) but doesn't catch the ultimate issue which is a poorly-formed docstring. I was focusing too narrowly while fixing these. I don't think we have an automated way of catching this type of issue (a non-type sitting in the position a type would normally go).
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] wjones127 commented on a diff in pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
wjones127 commented on code in PR #15214:
URL: https://github.com/apache/arrow/pull/15214#discussion_r1063626292
##########
python/pyarrow/_dataset.pyx:
##########
@@ -532,12 +532,12 @@ cdef class InMemoryDataset(Dataset):
Parameters
----------
- source : The data for this dataset.
+ source : The data for this dataset
Review Comment:
Why are the periods deleted? Other parameter descriptions, like the ones below, keep theirs.
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amoeba commented on pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
amoeba commented on PR #15214:
URL: https://github.com/apache/arrow/pull/15214#issuecomment-1374160693
Thanks for the review @wjones127. This is ready for another look.
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] wjones127 commented on a diff in pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
wjones127 commented on code in PR #15214:
URL: https://github.com/apache/arrow/pull/15214#discussion_r1063628175
##########
python/pyarrow/_dataset_parquet.pyx:
##########
@@ -236,9 +236,9 @@ class RowGroupInfo:
Parameters
----------
- id : the group id.
- metadata : the rowgroup metadata.
- schema : schema of the rows.
+ id : the group id
Review Comment:
Similar to before, the place after the colon is for the type, so the description should be moved to the next line I think.
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amoeba commented on a diff in pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
amoeba commented on code in PR #15214:
URL: https://github.com/apache/arrow/pull/15214#discussion_r1063814497
##########
python/pyarrow/_dataset_parquet.pyx:
##########
@@ -67,11 +67,11 @@ cdef class ParquetFileFormat(FileFormat):
Parameters
----------
read_options : ParquetReadOptions
- Read options for the file.
+ Read options for the file
Review Comment:
Not sure what I was doing there. I'll add the period back in.
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amoeba commented on pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
amoeba commented on PR #15214:
URL: https://github.com/apache/arrow/pull/15214#issuecomment-1374184438
Thanks @wjones127, those look good. The help is appreciated :)
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] wjones127 merged pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
wjones127 merged PR #15214:
URL: https://github.com/apache/arrow/pull/15214
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15214:
URL: https://github.com/apache/arrow/pull/15214#issuecomment-1372979492
https://issues.apache.org/jira/browse/ARROW-15006
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
ursabot commented on PR #15214:
URL: https://github.com/apache/arrow/pull/15214#issuecomment-1374352884
['Python', 'R'] benchmarks have high level of regressions.
[ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/bf6911d51cde4366af207f8ffb049a08...d4214740d2dd4ceeab768a72a060d507/)
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
ursabot commented on PR #15214:
URL: https://github.com/apache/arrow/pull/15214#issuecomment-1374352840
Benchmark runs are scheduled for baseline = a580f2711750ef507cc57ce48cb431dd700a6166 and contender = 14ec80f182532b960cd4b5d1e72bcad04ba651da. 14ec80f182532b960cd4b5d1e72bcad04ba651da is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/f761335634ac4d91bc4d60d29d458cae...bef68465ad2d4bd385392f7e4eb96100/)
[Failed :arrow_down:0.84% :arrow_up:0.19%] [test-mac-arm](https://conbench.ursa.dev/compare/runs/138de44aff774ae0a86c03b277bd32ba...0f9334b59c5e464a8c7a0d2218d660da/)
[Finished :arrow_down:3.06% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/bf6911d51cde4366af207f8ffb049a08...d4214740d2dd4ceeab768a72a060d507/)
[Finished :arrow_down:0.1% :arrow_up:0.0%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/c0a3cc1e9b6642cd93d0d09e3e8b2984...8b704106b82a479ca93c17662e852e59/)
Buildkite builds:
[Finished] [`14ec80f1` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2125)
[Failed] [`14ec80f1` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/2148)
[Finished] [`14ec80f1` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2120)
[Finished] [`14ec80f1` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2140)
[Finished] [`a580f271` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2124)
[Finished] [`a580f271` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/2147)
[Finished] [`a580f271` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2119)
[Finished] [`a580f271` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2139)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] wjones127 commented on a diff in pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
wjones127 commented on code in PR #15214:
URL: https://github.com/apache/arrow/pull/15214#discussion_r1063627428
##########
python/pyarrow/_dataset.pyx:
##########
@@ -532,12 +532,12 @@ cdef class InMemoryDataset(Dataset):
Parameters
----------
- source : The data for this dataset.
+ source : The data for this dataset
Review Comment:
Actually this one makes sense; the description here is in the spot for the datatype, which isn't supposed to have a period. I think this comment needs to be fixed to have a type, then this description should go on the next line.
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amoeba commented on pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
amoeba commented on PR #15214:
URL: https://github.com/apache/arrow/pull/15214#issuecomment-1372981882
Hey @jorisvandenbossche, since you reviewed [the last numpydoc PR](https://github.com/apache/arrow/pull/13983), would you want to take a look here? This adds five of the ten checks we discussed ([Jira](https://issues.apache.org/jira/browse/ARROW-15006), [Google Sheet](https://docs.google.com/spreadsheets/d/1NVzQe3MA4Mh-AqsWUmwIZu9r5gB-Lmugz7mge3stYvU)) adding and the diff is relatively straightforward compared to the last one.
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] wjones127 commented on a diff in pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
wjones127 commented on code in PR #15214:
URL: https://github.com/apache/arrow/pull/15214#discussion_r1063627666
##########
python/pyarrow/_dataset_parquet.pyx:
##########
@@ -67,11 +67,11 @@ cdef class ParquetFileFormat(FileFormat):
Parameters
----------
read_options : ParquetReadOptions
- Read options for the file.
+ Read options for the file
Review Comment:
This one is puzzling though. Why remove this period?
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amoeba commented on a diff in pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
amoeba commented on code in PR #15214:
URL: https://github.com/apache/arrow/pull/15214#discussion_r1063814833
##########
python/pyarrow/_dataset_parquet.pyx:
##########
@@ -236,9 +236,9 @@ class RowGroupInfo:
Parameters
----------
- id : the group id.
- metadata : the rowgroup metadata.
- schema : schema of the rows.
+ id : the group id
Review Comment:
Same response as above too, though I think I can fix this in this PR.
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] wjones127 commented on a diff in pull request #15214: ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI
Posted by GitBox <gi...@apache.org>.
wjones127 commented on code in PR #15214:
URL: https://github.com/apache/arrow/pull/15214#discussion_r1063831566
##########
python/pyarrow/ipc.pxi:
##########
@@ -84,11 +84,11 @@ class ReadStats(_ReadStats):
Parameters
----------
- num_messages : number of messages.
- num_record_batches : number of record batches.
- num_dictionary_batches : number of dictionary batches.
- num_dictionary_deltas : delta of dictionaries.
- num_replaced_dictionaries : number of replaced dictionaries.
+ num_messages : number of messages
+ num_record_batches : number of record batches
+ num_dictionary_batches : number of dictionary batches
+ num_dictionary_deltas : delta of dictionaries
+ num_replaced_dictionaries : number of replaced dictionaries
Review Comment:
```suggestion
num_messages : int
Number of messages.
num_record_batches : int
Number of record batches.
num_dictionary_batches : int
Number of dictionary batches.
num_dictionary_deltas : int
Delta of dictionaries.
num_replaced_dictionaries : int
Number of replaced dictionaries.
```
##########
python/pyarrow/ipc.pxi:
##########
@@ -57,11 +57,11 @@ class WriteStats(_WriteStats):
Parameters
----------
- num_messages : number of messages.
- num_record_batches : number of record batches.
- num_dictionary_batches : number of dictionary batches.
- num_dictionary_deltas : delta of dictionaries.
- num_replaced_dictionaries : number of replaced dictionaries.
+ num_messages : number of messages
+ num_record_batches : number of record batches
+ num_dictionary_batches : number of dictionary batches
+ num_dictionary_deltas : delta of dictionaries
+ num_replaced_dictionaries : number of replaced dictionaries
Review Comment:
```suggestion
num_messages : int
Number of messages.
num_record_batches : int
Number of record batches.
num_dictionary_batches : int
Number of dictionary batches.
num_dictionary_deltas : int
Delta of dictionaries.
num_replaced_dictionaries : int
Number of replaced dictionaries.
```
##########
python/pyarrow/parquet/core.py:
##########
@@ -1309,7 +1313,7 @@ def get_index(self, key):
Parameters
----------
- key : The value for which we want to known the index.
+ key : The value for which we want to known the index
Review Comment:
```suggestion
key : str or int
The value for which we want to known the index.
```
##########
python/pyarrow/parquet/core.py:
##########
@@ -1222,6 +1225,7 @@ def read(self, columns=None, use_threads=True, partitions=None,
Returns
-------
table : pyarrow.Table
+ The pierce as a pyarrow.Table
Review Comment:
```suggestion
The piece as a pyarrow.Table.
```
##########
python/pyarrow/ipc.pxi:
##########
@@ -108,14 +108,14 @@ cdef class IpcReadOptions(_Weakrefable):
----------
ensure_native_endian : bool
Whether to convert incoming data to platform-native endianness.
- Default is true.
+ Default is true
Review Comment:
```suggestion
```
##########
python/pyarrow/ipc.pxi:
##########
@@ -108,14 +108,14 @@ cdef class IpcReadOptions(_Weakrefable):
----------
ensure_native_endian : bool
Review Comment:
```suggestion
ensure_native_endian : bool, default True
```
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org