Rewording around `config` as a must have
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the Configuration section at https://docs.pyscript.net/2024.6.1/user-guide/configuration/ and review its opening paragraph about configuring Python environments. Done means the paragraph clearly explains that config is optional and avoids suggesting that every interpreter needs one, including the case of an empty config.
Written by the indexing model from the issue text.
Description
We had the community call https://www.youtube.com/watch?reload=9&v=2D7Wjoj2lXc and it was clear the optional need for a config attribute or <py-config> or even <mpy-config> is not super clear in our docs.
We start the configuration section like this: https://docs.pyscript.net/2024.6.1/user-guide/configuration/
We need to tell PyScript how we want such Python environments to be configured
While true as a statement, this is a bit misleading in there to me: we don't need to tell anything to any interpreter ... unless we do.
This issue is to try brainstorming or improve that initial Configuration paragraph that sounds like a config is needed by all mean, and we already had users slightly confused about empty configs and the config meaning in general.
- Dominant language
- Python
- Stars
- 17
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Contributor guide
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 pyscript/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
canonical/paas-charm#368 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
StevenBlack/hosts#3256 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
qualcomm/qai-appbuilder#275 ·