UCL / UCL/rsd-engineeringcourse
'Testing" page
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 133
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
Description
-
if not done already we should explain the difference between the 2 forms of import statement:
import X as Y
from A import B -
at this stage in the course we haven't done a huge amount of Python and we are suddenly confronted with a nested function with no explanation of what this is etc.
-
verts list repeats (left, bottom). Is that a mistake or is it deliberate? Actually if it's connected with Path.CLOSEPOLY I guess it's deliberate
-
In path1, path2 what is the effect of the * operator? e.g. vertices(*field1)?
-
In show_fields() function call, what are the dots for after the integers? We should explain what that means.
-
first attempt at overlap() has left, bottom, top, right.
Are we sure that shouldn't be left, bottom,right,top? It's not clear.
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 the course’s “Testing” page and review the import examples, nested function, repeated vertices, starred arguments, trailing dots, and overlap coordinate order listed in the issue. Clarify each point in the page, confirming whether the vertices repetition is intentional and documenting the Python syntax and coordinate ordering; the work is done when these examples are understandable without unstated prior knowledge.
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
- Needs clarification
- Newbie friendliness
- 35/100