Consistency with variable name
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 264
- Avg merge
- 1d 13m
- Merged PRs (30d)
- 23
Description
Based on @GaelVaroquaux's presentation on open-source, we have to say that it is very important to have standardized names and to use exactly the same variable to avoid extra cognitive load.
This image comes from his slides:
I feel like we are not doing this; the case of datasets is more obvious. We sometimes define subjects in some dataset objects, we define subject_list to get data using paradigm, and subjects for the function inside the dataset.
I am in favour of using subjects and putting the type that is a list or doing the cast.
Ideally, we would have some automatic way to do the checking and would be careful with the changes.
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.
Research direction
No files or tests are named. Start by locating dataset objects and the uses of subjects, subject_list, and subjects, then determine the full scope of the naming inconsistencies. Done means the agreed naming convention is applied consistently and any checking approach is documented or covered by the relevant tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100