Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

docstring improvements

Đang mở
  • Có gì không ổn?
#322 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Search for the docstrings of cf_xarray.bounds_to_vertices, vertices_to_bounds, shapely_to_cf, cf_to_shapely, and set_options, then compare them with the listed numpydoc warnings. Update the summaries, parameter and return documentation, See Also sections, and examples as applicable, and confirm that the reported validation warnings are resolved.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation good first issue help wanted

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
Ngôn ngữ chính
Python
Star
181
Fork
51
Merge trung bình
6 giờ 39 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của xarray-contrib/cf-xarray

Tất cả issue của xarray-contrib/cf-xarray

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.