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

doc/contributing.rst: benchmark commands are stale (--quick, test_build.py, memory.py)

Đang mở
  • Có gì không ổn?
#1,065 0 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

@dbisina đang làm issue này rồi.

Từ ngày 26/10/2026.

  • #1066 của @dbisina — đang mở

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả 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

Read the “Performance Benchmarks” section in doc/contributing.rst and compare its commands with benchmarks/README.md. Check the documented setup against the dev and benchmarks extras, then update the section to use the README’s current commands or link to it. Done when the instructions work with the required extras and match the benchmark layout; pull request #1066 is already open.

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

Mô tả

documentation

[!NOTE]
The following content was generated by AI.

The "Performance Benchmarks" section of doc/contributing.rst (lines 86-99) is out of date with benchmarks/:

    # Quick timing benchmarks
    pytest benchmarks/ --quick

    # Compare timing between branches
    pytest benchmarks/test_build.py --benchmark-save=master
    pytest benchmarks/test_build.py --benchmark-save=my-feature --benchmark-compare=0001_master

    # Compare peak memory between branches
    python benchmarks/memory.py save master --quick

Verified on master (ae80bc89), after uv sync --extra benchmarks:

  • pytest benchmarks/ --quick → pytest: error: unrecognized arguments: --quick. benchmarks/conftest.py only registers --pipeline; benchmarks/README.md uses pytest benchmarks/ --benchmark-disable -q as the smoke run.
  • benchmarks/test_build.py does not exist; it moved to benchmarks/drivers/test_build.py.
  • benchmarks/memory.py does not exist (can't open file ... benchmarks/memory.py).

The uv sync --extra benchmarks line (87) is required and correct: with only the dev extra, pytest benchmarks/drivers/test_build.py fails with fixture 'benchmark' not found. Worth stating that explicitly, since uv sync --extra benchmarks alone drops dev.

Proposed fix: replace the block with the commands from benchmarks/README.md (or just point there).

Ngôn ngữ chính
Python
Star
263
Fork
92
Merge trung bình
1 ngày 13 giờ
Pull request đã merge (30 ngày)
32

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

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 PyPSA/linopy

Tất cả issue của PyPSA/linopy

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.