Add comment explaining how to properly import types
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Find the sirius_cyber_corp example and inspect how its type-related imports are documented. Add a comment explaining the required nested import and usage pattern, including why importing only top_folder does not work; done means the example clearly communicates this distinction.
Written by the indexing model from the issue text.
Description
sirius_cyber_corp example shows how to work with types in the top directory, however if the type is located in a folder, one has to make sure to import the type as follows:
import top_folder.sub_folder.some_type # import like this
top_folder.sub_folder.some_type # use like this
# This won't work
import top_folder
top_folder.sub_folder.some_type # This will give an error
- Dominant language
- Python
- Stars
- 143
- Forks
- 110
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenCyphal/pycyphal
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
OpenCyphal/pycyphal#396 ·
-
class-feature domain-core help wanted severity-minor
Difficulty 4/5 3-5 days Newbie friendliness 38/100
OpenCyphal/pycyphal#339 ·
-
DiagnosticPublisher attempts to use the main asyncio event loop from worker threads (which fails)Openclass-defect domain-core help wanted severity-major
Difficulty 3/5 1-2 days Newbie friendliness 45/100
OpenCyphal/pycyphal#336 ·
-
class-defect domain-core help wanted severity-minor
Difficulty 3/5 1-2 days Newbie friendliness 38/100
OpenCyphal/pycyphal#334 ·
-
class-defect domain-transport-redundant domain-transport-udp help wanted
Difficulty 4/5 3-5 days Newbie friendliness 38/100
OpenCyphal/pycyphal#314 · 2 comments ·
All issues in OpenCyphal/pycyphal
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
py-econometrics/pyfixest#2072 ·
Maintainers usually reply within 1 day
-
~planning docs
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Kromatic-Innovation/athenaeum#3084 ·
Maintainers usually reply within 1 day
-
Bosch Room Thermostat II number entities offer -500 to 3000 °C setpoint limits and a -32768 to 32767 °C outdoor temperaturePossibly taken @zigpy-review-bot claimed this today. Openbot: code audit
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
zigpy/zha-device-handlers#5769 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 80/100
R0Y00/Xbox2Windows#254 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kludex/python-multipart#375 ·
Maintainers usually reply within 1 day