docs: developer gaps from the 0.7.0 review

Đang mở
#512 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

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
52/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Start with docs/reference/rest.md and engine.md, then locate the exports from pivotkit-core/import, pivotkit-element, and pivotkit-react to confirm their names and chart constants. Update the examples and descriptions for authentication, 403 errors, invalid filters, and the differing view type names. Done when each listed gap is documented accurately; the issue does not name tests to run.

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

Mô tả

documentation

Developer-facing gaps from the full review before 0.7.0:

  • docs/reference/rest.md embed example needs PIVOTKIT_TOKEN or auth.tokens and leaves rows undefined.
  • 403 NOT_ALLOWED text says "your token may not download files" when the server has no sign-in.
  • Undocumented exports: cleanText (pivotkit-core/import) and the chart constants BOTTOM_LEGEND_ROOM, CATEGORY_LABEL_WIDTH, GROUP_LABEL_ROOM, RIGHT_LEGEND_MIN_WIDTH, SLANTED_LABEL_WIDTH.
  • computePivot drops an invalid filter and returns the unfiltered pivot; engine.md should tell hosts to check issues for errors (or a strict option).
  • pivotkit-element exports PivotView, pivotkit-react uses ViewInput for the same thing.
Ngôn ngữ chính
JavaScript
Star
1
Fork
1
Merge trung bình
3 giờ 34 phút
Pull request đã merge (30 ngày)
213

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 eizedev/pivotkit

Tất cả issue của eizedev/pivotkit

Issue tương tự

Thêm issue về JavaScript

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.