Docs: describe how key flags work
- Ngôn ngữ chính
- Python
- Star
- 2.5k
- Fork
- 279
- Merge trung bình
- 2 ngày 1 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
Currently docs say:
> --help: prints a list of all key flags (see below).
However, this is the only mention of `key` flags. Reading issues I see these are inferred automagically from the main module, and that perhaps `flags.declare_key_flag` can somehow be used to manually declare them, at least in some circumstances. None of this is documented though and scrambling through what little there is, I was not able to make it work in a multi module environment where I want to selectively surface some flags from various modules into the top level `--helpshort`. As an alternative I could centralize flag definitions, but then I would still need documentation on key flags to be able to select from that central definition which are key flags and which are not.
Hướng dẫn đóng góp
Hướng nghiên cứu
Look at the abseil-py source code for flag definitions and the `declare_key_flag` function. Examine existing documentation files to understand the current structure. Test flag behavior in a simple multi-module setup to verify how key flags are inferred or declared. The goal is to add clear documentation explaining key flags, their automatic inference, and manual declaration with examples.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 70/100