Reducing "read in" jargon

Open Beginner friendly
#641 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
pandas, python
Domain
documentation

Research direction

Start in the "Combining DataFrames with Pandas" episode and search its code comments for uses of "read in" that describe subsetting rather than loading data. Update those comments with unambiguous wording, then review the episode to confirm every subsetting reference is clear to learners.

Written by the indexing model from the issue text.

Description

How could the content be improved?

At several places in the "Combining DataFrames with Pandas" episode, the code comments use "read in" to describe subsetting data. This could be confusing to learners, who would be familiar with "reading" as loading in data from, e.g., a csv (the read_csv command). I would suggest that instances of "read in" which refer to subsetting be re-worded. Example alternatives: "Subset first ten lines of surveys table" or "Save first ten lines of surveys table as a new object."

Which part of the content does your suggestion apply to?

No response

Dominant language
Jupyter Notebook
Stars
176
Forks
316
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

More from datacarpentry/python-ecology-lesson

All issues in datacarpentry/python-ecology-lesson

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.