UCL / UCL/rsd-engineeringcourse

"The Fields of Saskatchewan" page

Open
#90 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2018-19
Dominant language
Python
Stars
133
Forks
111
PR merge metrics
No merged PRs in 30d

Description

  • How is the original problem reduced to finding the overlap? Not very important for here, but would be good to know how to explain/if someone asks
  • In cell where show_fields is defined, the last line (call to show_fields) is missing a space between arguments
  • After first plot: punctuation could be improved in a few places, sentences broken up strangely (eg "we can see that the area of overlap, is the same..." should not have a comma)
  • Definition of overlap: lots of spaces missing for PEP8
  • Using our tests: Would it be better to split this page in two different ones? One where we show how we decide which cases to test, and another in which we discuss how to run the tests (assertions vs running manually (and the rest of the page), leading into testing frameworks)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “The Fields of Saskatchewan” page and review the cell defining show_fields, the overlap definition, the text after the first plot, and the testing section. Check the missing spacing, PEP8 formatting, punctuation, and explanation of how the original problem becomes an overlap problem. Done means the page reads clearly and the proposed testing content is organized appropriately.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.