golemfactory / golemfactory/golem-docs
NO-QA code in Python example
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 7
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
there is the Python example, but it does not run. Module "utils" refers to a non-existing "build_parser", "print_env_info", "run_golem_example" names.
These imports are commented with "NO-QA", exactly the line below:
from utils import build_parser, print_env_info, run_golem_example # noqa
Probably it has been working in the past, but over a time as module utils has changed this No Quality code has been removed.
I can rewrite that example, let me know if it's fine for you.
Also, would it be possible to split python code from MarkDown? So, .md would contain something like:
include path/to/example.py
?
Cheers,
Mateusz (Barnaba)
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start with src/pages/docs/reputation/finding-the-best-providers.md and inspect the embedded Python example and its imports from utils. Check which referenced names still exist, then make the documented example runnable and verify the Markdown and Python example remain consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100