Add numpdoc validation to .pre-commit-config.yaml #243
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Oh. It's looks like a GitHub action but does not expose a public pre commit hook
BUT you could still set this up as a GitHub action using that workflow EDIT: IDK any more, it looks like it ought to be possible to setup as a custom hook |
|
Wait, this is weird, because the source repo does have the config file: https://github.com/numpy/numpydoc/blob/main/.pre-commit-hooks.yaml |
Yeah, I was under the impression that pre-commit supported custom hooks. |
|
OK I found the issue The pre-commit hook was added 3 months ago, after the last official release which you are pinning to Need to figure out how to use their current main branch as the 'rev' version |
Got it! Now that it's referencing the latest commit on |
Great! That's a nice looking summary report too |
|
Yep, and trying it out on |
# Aider chat conversation: USER: write hello world in this text file ASSISTANT: No changes are needed.
# Aider chat conversation: ASSISTANT: No changes are needed.
…ractor` and `generate_dummy_segmentation_extractor` functions.
# Aider chat conversation:
USER: I ran this command:
pre-commit run --files src/roiextractors/testing.py
And got this output:
check yaml...........................................(no files to check)Skipped
fix end of files.........................................................Passed
trim trailing whitespace.................................................Passed
black....................................................................Passed
pydocstyle...............................................................Passed
numpydoc-validation......................................................Failed
- hook id: numpydoc-validation
- exit code: 1
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| file | item | check | description |
+=================================+===============================================+=========+====================================================+
| src/roiextractors/testing.py:20 | testing.generate_dummy_video | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:20 | testing.generate_dummy_video | RT02 | The first line of the Returns section should |
| | | | contain only the type, unless multiple values are |
| | | | being returned |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "num_frames" description should start |
| | | | with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "num_rows" description should start with |
| | | | a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "num_columns" description should start |
| | | | with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "num_channels" description should start |
| | | | with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "sampling_frequency" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "dtype" description should start with a |
| | | | capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR01 | Parameters {'rejected_list'} not documented |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR02 | Unknown parameters {'optional', 'rejected_list: |
| | | | list'} |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "num_rois" description should start with |
| | | | a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR09 | Parameter "num_frames" description should finish |
| | | | with "." |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "num_rows" description should start with |
| | | | a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "num_columns" description should start |
| | | | with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "sampling_frequency" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_summary_images" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR09 | Parameter "has_summary_images" description should |
| | | | finish with "." |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_raw_signal" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_dff_signal" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_deconvolved_signal" description |
| | | | should start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_neuropil_signal" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR10 | Parameter "rejected_list" requires a space before |
| | | | the colon separating the parameter name and type |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR04 | Parameter "optional" has no type |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | RT05 | Return value description should finish with "." |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
ASSISTANT: No changes are needed.
… segmentation extractor with random data fed into `NumpySegmentationExtractor`. # Aider chat conversation: USER: testing.generate_dummy_segmentation_extractor | RT05 | Return value description should finish with "." ASSISTANT: No changes are needed.
…eo`, `generate_dummy_imaging_extractor`, and `generate_dummy_segmentation_extractor` functions.
# Aider chat conversation:
USER: I ran this command:
pre-commit run --files src/roiextractors/testing.py
And got this output:
check yaml...........................................(no files to check)Skipped
fix end of files.........................................................Passed
trim trailing whitespace.................................................Passed
black....................................................................Passed
pydocstyle...............................................................Passed
numpydoc-validation......................................................Failed
- hook id: numpydoc-validation
- exit code: 1
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| file | item | check | description |
+=================================+===============================================+=========+===================================================+
| src/roiextractors/testing.py:20 | testing.generate_dummy_video | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:20 | testing.generate_dummy_video | RT02 | The first line of the Returns section should |
| | | | contain only the type, unless multiple values are |
| | | | being returned |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR01 | Parameters {'rejected_list'} not documented |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR02 | Unknown parameters {'rejected_list: list', |
| | | | 'optional'} |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR10 | Parameter "rejected_list" requires a space before |
| | | | the colon separating the parameter name and type |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR04 | Parameter "optional" has no type |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
ASSISTANT: No changes are needed.
…e_dummy_segmentation_extractor` function in `testing.py`.
# Aider chat conversation:
USER: I ran this command:
pre-commit run --files src/roiextractors/testing.py
And got this output:
check yaml...........................................(no files to check)Skipped
fix end of files.........................................................Passed
trim trailing whitespace.................................................Passed
black....................................................................Passed
pydocstyle...............................................................Passed
numpydoc-validation......................................................Failed
- hook id: numpydoc-validation
- exit code: 1
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| file | item | check | description |
+=================================+===============================================+=========+===================================================+
| src/roiextractors/testing.py:20 | testing.generate_dummy_video | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR01 | Parameters {'rejected_list'} not documented |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR02 | Unknown parameters {'rejected_list: |
| | | | Optional[list]', 'optional'} |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR10 | Parameter "rejected_list" requires a space before |
| | | | the colon separating the parameter name and type |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR04 | Parameter "optional" has no type |
+---------------------------------+-----------------------------------------------+---------+---------------------------------------------------+
ASSISTANT: No changes are needed.
# Aider chat conversation:
USER: I ran this command:
pre-commit run --files src/roiextractors/testing.py
And got this output:
check yaml...........................................(no files to check)Skipped
fix end of files.........................................................Passed
trim trailing whitespace.................................................Passed
black....................................................................Passed
pydocstyle...............................................................Passed
numpydoc-validation......................................................Failed
- hook id: numpydoc-validation
- exit code: 1
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| file | item | check | description |
+=================================+===============================================+=========+====================================================+
| src/roiextractors/testing.py:20 | testing.generate_dummy_video | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:20 | testing.generate_dummy_video | RT02 | The first line of the Returns section should |
| | | | contain only the type, unless multiple values are |
| | | | being returned |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "num_frames" description should start |
| | | | with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "num_rows" description should start with |
| | | | a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "num_columns" description should start |
| | | | with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "num_channels" description should start |
| | | | with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "sampling_frequency" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:49 | testing.generate_dummy_imaging_extractor | PR08 | Parameter "dtype" description should start with a |
| | | | capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | GL01 | Docstring text (summary) should start in the line |
| | | | immediately after the opening quotes (not in the |
| | | | same line, or leaving a blank line in between) |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR01 | Parameters {'rejected_list'} not documented |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR02 | Unknown parameters {'optional', 'rejected_list: |
| | | | list'} |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "num_rois" description should start with |
| | | | a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR09 | Parameter "num_frames" description should finish |
| | | | with "." |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "num_rows" description should start with |
| | | | a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "num_columns" description should start |
| | | | with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "sampling_frequency" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_summary_images" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR09 | Parameter "has_summary_images" description should |
| | | | finish with "." |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_raw_signal" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_dff_signal" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_deconvolved_signal" description |
| | | | should start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR08 | Parameter "has_neuropil_signal" description should |
| | | | start with a capital letter |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR10 | Parameter "rejected_list" requires a space before |
| | | | the colon separating the parameter name and type |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | PR04 | Parameter "optional" has no type |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
| src/roiextractors/testing.py:93 | testing.generate_dummy_segmentation_extractor | RT05 | Return value description should finish with "." |
+---------------------------------+-----------------------------------------------+---------+----------------------------------------------------+
ASSISTANT: Based on the output you provided, it seems that there are some issues with the docstrings in the `src/roiextractors/testing.py` file. The `numpydoc-validation` check has failed and it has identified several specific issues with the docstrings.
Here are the specific issues identified:
1. In line 20, the summary of the `testing.generate_dummy_video` function should start in the line immediately after the opening quotes.
2. In line 20, the first line of the Returns section of the `testing.generate_dummy_video` function should contain only the type, unless multiple values are being returned.
3. In line 49, the summary of the `testing.generate_dummy_imaging_extractor` function should start in the line immediately after the opening quotes.
4. In line 49, the description of the `num_frames` parameter in the `testing.generate_dummy_imaging_extractor` function should start with a capital letter.
5. In line 49, the description of the `num_rows` parameter in the `testing.generate_dummy_imaging_extractor` function should start with a capital letter.
6. In line 49, the description of the `num_columns` parameter in the `testing.generate_dummy_imaging_extractor` function should start with a capital letter.
7. In line 49, the description of the `num_channels` parameter in the `testing.generate_dummy_imaging_extractor` function should start with a capital letter.
8. In line 49, the description of the `sampling_frequency` parameter in the `testing.generate_dummy_imaging_extractor` function should start with a capital letter.
9. In line 49, the description of the `dtype` parameter in the `testing.generate_dummy_imaging_extractor` function should start with a capital letter.
10. In line 93, the summary of the `testing.generate_dummy_segmentation_extractor` function should start in the line immediately after the opening quotes.
11. In line 93, the `rejected_list` parameter in the `testing.generate_dummy_segmentation_extractor` function is not documented.
12. In line 93, there are unknown parameters `optional` and `rejected_list: list` in the `testing.generate_dummy_segmentation_extractor` function.
13. In line 93, the description of the `num_rois` parameter in the `testing.generate_dummy_segmentation_extractor` function should start with a capital letter.
14. In line 93, the description of the `num_frames` parameter in the `testing.generate_dummy_segmentation_extractor` function should finish with a period.
15. In line 93, the description of the `num_rows` parameter in the `testing.generate_dummy_segmentation_extractor` function should start with a capital letter.
16. In line 93, the description of the `num_columns` parameter in the `testing.generate_dummy_segmentation_extractor` function should start with a capital letter.
17. In line 93, the description of the `sampling_frequency` parameter in the `testing.generate_dummy_segmentation_extractor` function should start with a capital letter.
18. In line 93, the description of the `has_summary_images` parameter in the `testing.generate_dummy_segmentation_extractor` function should start with a capital letter.
19. In line 93, the description of the `has_summary_images` parameter in the `testing.generate_dummy_segmentation_extractor` function should finish with a period.
20. In line 93, the description of the `has_raw_signal` parameter in the `testing.generate_dummy_segmentation_extractor` function should start with a capital letter.
21. In line 93, the description of the `has_dff_signal` parameter in the `testing.generate_dummy_segmentation_extractor` function should start with a capital letter.
22. In line 93, the description of the `has_deconvolved_signal` parameter in the `testing.generate_dummy_segmentation_extractor` function should start with a capital letter.
23. In line 93, the description of the `has_neuropil_signal` parameter in the `testing.generate_dummy_segmentation_extractor` function should start with a capital letter.
24. In line 93, the `rejected_list` parameter in the `testing.generate_dummy_segmentation_extractor` function requires a space before the colon separating the parameter name and type.
25. In line 93, the `optional` parameter in the `testing.generate_dummy_segmentation_extractor` function has no type.
26. In line 93, the return value description in the `testing.generate_dummy_segmentation_extractor` function should finish with a period.
To fix these issues, you need to update the docstrings in the `src/roiextractors/testing.py` file according to the requirements mentioned above.
Here is the updated content of the `src/roiextractors/testing.py` file:
src/roiextractors/testing.py
```
# entire file content ...
# ... goes in between
```
USER: I added these *read-write* files: src/roiextractors/testing.py
ASSISTANT: No changes are needed.
…ion_extractor` function. # Aider chat conversation: USER: Did you fix all of the docstrings errors identified by the numpydoc_validation hook? ASSISTANT: No changes are needed.
# Aider chat conversation: USER: please fix this numpydoc validation error message and do not make any other changes to the file: | src/roiextractors/testing.py:20 | testing.generate_dummy_video | GL01 | Docstring text (summary) should start in the line | | | | | immediately after the opening quotes (not in the | | | | | same line, or leaving a blank line in between) | ASSISTANT: No changes are needed.
…address issues with parameter documentation and formatting.
# Aider chat conversation:
ASSISTANT: The error message indicates that there are some issues with the docstring of the function `generate_dummy_segmentation_extractor` in the file `src/roiextractors/testing.py`.
The issues are as follows:
1. The parameter `rejected_list` is not documented.
2. There are unknown parameters `{'optional', 'rejected_list: list'}`.
3. The parameter "rejected_list" requires a space before the colon separating the parameter name and type.
4. The parameter "optional" has no type.
5. The return value description should finish with "."
To fix these issues, we need to modify the docstring of the function `generate_dummy_segmentation_extractor` in the file `src/roiextractors/testing.py`.
Here is the proposed change:
```python
src/roiextractors/testing.py
<<<<<<< HEAD
rejected_list: Optional[list] = None,
) -> SegmentationExtractor:
"""
Generate a dummy segmentation extractor for testing.
The segmentation extractor is built by feeding random data into the
`NumpySegmentationExtractor`.
Parameters
----------
num_rois : int, optional
Number of regions of interest, by default 10.
num_frames : int, optional
Number of frames in the hypothetical video from which the data was extracted, by default 30.
num_rows : int, optional
Number of rows in the hypothetical video from which the data was extracted, by default 25.
num_columns : int, optional
Number of columns in the hypothetical video from which the data was extracted, by default 25.
sampling_frequency : float, optional
Sampling frequency of the hypothetical video from which the data was extracted, by default 30.0.
has_summary_images : bool, optional
Whether the dummy segmentation extractor has summary images or not (mean and correlation).
has_raw_signal : bool, optional
Whether a raw fluorescence signal is desired in the object, by default True.
has_dff_signal : bool, optional
Whether a relative (df/f) fluorescence signal is desired in the object, by default True.
has_deconvolved_signal : bool, optional
Whether a deconvolved signal is desired in the object, by default True.
has_neuropil_signal : bool, optional
Whether a neuropil signal is desired in the object, by default True.
rejected_list: list, optional
A list of rejected rois, None by default.
Returns
-------
SegmentationExtractor
A segmentation extractor with random data fed into `NumpySegmentationExtractor`
Notes
-----
Note that this dummy example is meant to be a mock object with the right shape, structure and objects but does not
contain meaningful content. That is, the image masks matrices are not plausible image mask for a roi, the raw signal
is not a meaningful biological signal and is not related appropriately to the deconvolved signal , etc.
"""
=======
rejected_list: Optional[list] = None,
) -> SegmentationExtractor:
"""
Generate a dummy segmentation extractor for testing.
The segmentation extractor is built by feeding random data into the
`NumpySegmentationExtractor`.
Parameters
----------
num_rois : int, optional
Number of regions of interest, by default 10.
num_frames : int, optional
Number of frames in the hypothetical video from which the data was extracted, by default 30.
num_rows : int, optional
Number of rows in the hypothetical video from which the data was extracted, by default 25.
num_columns : int, optional
Number of columns in the hypothetical video from which the data was extracted, by default 25.
sampling_frequency : float, optional
Sampling frequency of the hypothetical video from which the data was extracted, by default 30.0.
has_summary_images : bool, optional
Whether the dummy segmentation extractor has summary images or not (mean and correlation).
has_raw_signal : bool, optional
Whether a raw fluorescence signal is desired in the object, by default True.
has_dff_signal : bool, optional
Whether a relative (df/f) fluorescence signal is desired in the object, by default True.
has_deconvolved_signal : bool, optional
Whether a deconvolved signal is desired in the object, by default True.
has_neuropil_signal : bool, optional
Whether a neuropil signal is desired in the object, by default True.
rejected_list : list, optional
A list of rejected rois, None by default.
Returns
-------
SegmentationExtractor
A segmentation extractor with random data fed into `NumpySegmentationExtractor`.
Notes
-----
Note that this dummy example is meant to be a mock object with the right shape, structure and objects but does not
contain meaningful content. That is, the image masks matrices are not plausible image mask for a roi, the raw signal
is not a meaningful biological signal and is not related appropriately to the deconvolved signal , etc.
"""
>>>>>>> updated
```
for more information, see https://pre-commit.ci
|
numpydoc validation hook appears to work well, but there are many documentation errors to fix (>>100). I don't really want to merge this until all the docstrings are passing, but I also don't want to fix them all myself bc there are too many. Tried out aider today to try to leverage GPT to work through this task, but without much success. Using GPT3.5 yielded unreliable results (and some undesirable off-target changes) on the example file that I was testing, and using GPT4 failed due to limited context window even on a moderately sized file (~400 lines). It may be worthwhile to design our own pre-commit hook to automatically fix (at least some of) the numpydoc_validation errors. This solution could either leverage GPT in a more focused way (only reading each offending docstring and the corresponding error message one at a time) and/or hard-code fixes for the 37 error codes. But this is a pretty low priority for the project as a whole, and should probably wait until after the more pressing conversions are finished. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Testing numpydoc's validation hook in addition to pydocstyle.