Public-Health-Scotland / Public-Health-Scotland/python-training
Course structure and content development
Open
Nobody has claimed this yet.
bug
enhancement
- Dominant language
- R
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Missing content or changes required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2291087419 - introduce users to the course
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2291090740 - where/how does Python get used in PHS
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2297858040 - incorrect instructions with out of date reference
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2297889761 - the foundation section is missing a lot of details, e.g. data types, comments, execution, and operators.
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2297897224 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2297925718 - incorrect description and missing content
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2297955788 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2297967336 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298010912 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298020473 - missing content on Python methods
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298037986 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298076333 - description of 0-based indexing
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298087041 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298100418 - description of variable assignment
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298104468 - bug in way exercise is created (file access)
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298112624 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298119638 - style guide issue with non-specific/incrementing variable names
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298134739 - change for preferred function
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298135587 - empty quiz
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298121132 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298136922 - empty exercise
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298144576 - bug in way exercise is created (hints and flow)
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298149611 - bug in way exercise is created (file access)
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298152126 - bug in way exercise is created (description and flow)
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298189403 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298211346 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298227034 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298230053 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298235279 - bug in way exercise is created (package management)
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298260819 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298289888 - more details required
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298298499 - use of deprecated function
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298344922 - what next? Support continuing development and advertise further packages or ways to use Python
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298351352 - how can users get help/support in the organisation?
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298353539 - feedback link is incorrect
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298363882 - out of date screenshot of Posit Workbench interface
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298080266 - section title too long
It may also be worth considering:
- referencing when and how things differ from R (as the common language used, helping users understand similarities and differences)
Structure or section move changes
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2297838704 - details of Python execution flow currently on homepage, move to 'Foundations'?
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2297868774 - details of Python libraries introduced in 'IDE' section, move to 'Functions & Packages'?
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298028513 - control flow section introduced after functions, move to before?
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298087926 - subset of function introduced as new section
- https://github.com/Public-Health-Scotland/python-training/pull/4#discussion_r2298322861 - content is about data access, section on wrangling is missing?
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 by reviewing pull request #4 and its linked discussion threads, then map the requested changes across the course introduction, Foundations, functions and packages, control flow, data access, exercises, quizzes, and support sections. Done requires resolving the listed content, structure, instructional, exercise, link, and screenshot issues, while deciding whether to include R comparisons.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, r
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100