Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docstring improvements #322

Open
dcherian opened this issue Apr 2, 2022 · 0 comments
Open

docstring improvements #322

dcherian opened this issue Apr 2, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@dcherian
Copy link
Contributor

dcherian commented Apr 2, 2022

Would be good to clean up these warnings

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.bounds_to_vertices':
  SS06: Summary should fit in a single line
  PR03: Wrong parameters order. Actual: ('bounds', 'bounds_dim', 'core_dims', 'order'). Documented: ('bounds', 'bounds_dim', 'order', 'core_dims')
  SA01: See Also section not found
  EX01: No examples section found

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.vertices_to_bounds':
  SS06: Summary should fit in a single line
  RT03: Return value has no description
  SA01: See Also section not found
  EX01: No examples section found

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.shapely_to_cf':
  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)
  SA01: See Also section not found
  EX01: No examples section found

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.cf_to_shapely':
  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)
  SA01: See Also section not found
  EX01: No examples section found

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.set_options':
  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)
  ES01: No extended summary found
  PR01: Parameters {'**kwargs'} not documented
  PR02: Unknown parameters {'custom_criteria', 'warn_on_missing_variables'}
  SA01: See Also section not found
@dcherian dcherian added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Apr 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant