Improve docstrings for Hooks

Đang mở
#269 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
45/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

Bắt đầu bằng cách tìm các interface Hook công khai, bao gồm HookContext, trong package cloudformation_cli_python_lib, sau đó so sánh chúng với ví dụ được tạo ../handlers.py và tài liệu Implement Hook handlers (Python). Xem xét cách request.hookContext và targetModel được cung cấp. Công việc được xem là hoàn thành khi các class và property công khai liên quan có các Python docstring hữu ích giải thích ý nghĩa và các giá trị dự kiến của chúng.

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

Mô tả

Hi there 👋,

It would be nice to have Python docstrings included on the public interfaces when developing hooks.
Would pull requests for docstrings be welcome?

For example, after cfn init for hooks, we have a ../handlers.py that looks similar to this:
image

In Visual Studio Code, when I hover over cloudformation_cli_python_lib specific classes/properties I don't get any information for what they are, or what to expect.

I couldn't find out what all the request.hookContext properties mean, and what dict keys are available on request.hookContext.targetModel from the Implement Hook handlers (Python) documentation.

In the case of HookContext some docstrings like this would be welcome:
image

Cheers,
Neil

Ngôn ngữ chính
Python
Star
107
Fork
46
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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 aws-cloudformation/cloudformation-cli-python-plugin

Tất cả issue của aws-cloudformation/cloudformation-cli-python-plugin

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.