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

Eliminate confusing job option and format option handling in `create_job` (and related)

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

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

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

Hướng nghiên cứu

Bắt đầu với docs/cookbook/sampling.md và openeo/rest/datacube.py xung quanh create_job, đặc biệt là cách xử lý job_options và kwargs. Truy vết các đường dẫn đối số liên quan, sau đó làm rõ sự phân tách dự kiến giữa job options và format options, đồng thời cập nhật tài liệu và hành vi của API cho nhất quán.

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

Mô tả

clean up documentation technical debt usability

@mbuchhorn pointed me to this snippet from doc:
https://github.com/Open-EO/openeo-python-client/blob/7c321be49bcf6f1dbd091f5f4f4ea1c0163ed7e5/docs/cookbook/sampling.md?plain=1#L37-L42

I find this extremely confusing: the sample_by_feature looks like a job option this way, while the kwargs will be passed as format option:
https://github.com/Open-EO/openeo-python-client/blob/7c321be49bcf6f1dbd091f5f4f4ea1c0163ed7e5/openeo/rest/datacube.py#L2411-L2423

Note that there is a dedicated argument job_options for the job options, but the kwargs argument goes to format options, which is an optional feature here actually. I think we should get rid of this backwards argument handling

Ngôn ngữ chính
Python
Star
219
Fork
58
Merge trung bình
2 ngày 19 giờ
Pull request đã merge (30 ngày)
10

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 Open-EO/openeo-python-client

Tất cả issue của Open-EO/openeo-python-client

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.