01-numpy: add a few section headers. Improve text #538

maxim-belkin · 2018-05-23T21:09:23Z

No description provided.

ldko

I am excited about the content this merged request added to the Python lesson regarding an introduction to variable types and what makes a string etc. I did notice some things in the PR that might need changing, and I am wondering if there is any sort of policy or common practice on a maintainer having a second maintainer review a PR of his/hers before merging it.

ldko · 2018-05-23T22:18:17Z

_episodes/01-numpy.md


-We can also change a variable's value by assigning it a new one:
+To change variable's value, we have to assign it a new one:


Depending on the type of variable (immutable vs. mutable), it is not true that "we have to assign it a new one" to change the value. I find the old wording more accurate. If you want to use the new wording, it should say "a variable's value".

Hm.... interesting point. How about

To change value of `weight_kg` variable, we have to assign it a new one:

If you want to use the new wording, it should say "a variable's value".

I believe this contradicts the first statement:

Depending on the type of variable (immutable vs. mutable), it is not true that "we have to assign it a new one

ldko · 2018-05-23T22:18:29Z

_episodes/01-numpy.md

+* floating point numbers, and
+* strings.
+
+In the example above, variabe `weight_kg` has an integer value of `60`.


Typo: "variabe"

ldko · 2018-05-23T22:18:45Z

_episodes/01-numpy.md

+
+In Python, variable names:
+
+ - must begin with a letter, and


I realize that the statement "must begin with a letter" is not new to the episode here, but variable names are not actually required to begin with a letter. They could begin with an underscore. Would it make sense to specify that the variable names can include upper and lowercase letters, numbers, and underscores, but cannot start with a number?

variable names can include upper and lowercase letters, numbers, and underscores, but cannot start with a number

sounds reasonable. Shall we distinguish numbers and digits?

ldko · 2018-05-23T22:20:42Z

_episodes/01-numpy.md

+ - `weight` and `Weight` are different variables
+
+## Types of data
+Python knows various types of data. The most common ones are:


Are these "the most common"? It could say "Three common ones".

Sounds good

ldko · 2018-05-23T22:21:42Z

_episodes/01-numpy.md

+{: .language-python}
+
+## Using Variables in Python
+To display the value of a variable to the screen in Python, we can use `print` function:


Should this say "the print function"?

sounds good

ldko · 2018-05-23T22:27:30Z

_episodes/01-numpy.md

-If we imagine the variable as a sticky note with a name written on it,
-assignment is like putting the sticky note on a particular value:
+A variable is analoguous to a sticky note with a name written on it:
+assigning value to a variable is like putting that sticky note on a particular value.


Typo: analoguous
Should be "assigning a value"

alee · 2018-05-23T23:01:16Z

👍 @ldko

It'd be great to communally establish across all @swcarpentry/python-maintainers some consistent text that introduces these types of core programming language concepts - we have similar content here:

http://swcarpentry.github.io/python-novice-gapminder/02-variables/

maxim-belkin · 2018-05-24T00:30:19Z

I am wondering if there is any sort of policy or common practice on a maintainer having a second maintainer review a PR of his/hers before merging it.

I raised this question during maintainer onboarding.
Basically, there is no policy. But we do practice it when time permits and changes are more noticeable: see, for example, #536 where I requested a review from @annefou. The main change in this PR is, as you noticed, is that I mention strings without deviating away from the main story-line + headers.

See discussion here: swcarpentry#538

ldko · 2018-05-24T16:24:07Z

Thanks for the explanation about maintainer review policy, @maxim-belkin . It makes sense to me. It is subjective on what changes are considered noticeable though. Not specific to the Carpentries, I tend to think of PRs that could skip review (because of noticeability and time sensitivity) things like fixing a broken link, whereas PRs that change multiple explanations would benefit from a review, if not just for the sake of catching typos, because what seems clear and absolute to one person may not be interpreted the same by others.

By the way, I appreciate all the effort and time you have been volunteering to maintain this lesson. Thank you!

maxim-belkin · 2018-05-28T06:51:35Z

It is subjective on what changes are considered noticeable though.

100% agree.

I tend to think of PRs that could skip review (because of noticeability and time sensitivity) things like fixing a broken link, whereas PRs that change multiple explanations would benefit from a review, if not just for the sake of catching typos, because what seems clear and absolute to one person may not be interpreted the same by others.

This PR does not change multiple explanations.
Typos are typos.

This PR formally mentions strings, introduces a few "headers", and moves Notebook-specific text outside. At present, it is more important to pay attention to the overall state of the episode:
a) there is no way it can be taught in 30 minutes. It requires more like an hour.
b) it is difficult for learners because it goes through a lot of material (including slicing numpy arrays and grouping plots in matplotlib!!!!!)
c) all exercises are at the very end!

It'd be great to communally establish across all @swcarpentry/python-maintainers some consistent text that introduces these types of core programming language concepts - we have similar content here:

There should be an agreement on what topics/concepts have to be covered but "consistent text" would not make much sense, I think...

Closes #538

01-numpy: add a few section headers. Improve

985573b

maxim-belkin merged commit 9bffe66 into swcarpentry:gh-pages May 23, 2018

maxim-belkin deleted the redo-numpy branch May 23, 2018 21:10

ldko reviewed May 23, 2018

View reviewed changes

maxim-belkin added a commit to maxim-belkin/python-novice-inflammation that referenced this pull request May 24, 2018

01-numpy.md: fix typos, reword, improve

90ca550

See discussion here: swcarpentry#538

maxim-belkin mentioned this pull request May 24, 2018

01-numpy.md: fix typos, reword, improve #539

Merged

zkamvar pushed a commit that referenced this pull request Apr 21, 2023

01-numpy: add section headers. General improvements.

b6a4f51

Closes #538

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

01-numpy: add a few section headers. Improve text #538

01-numpy: add a few section headers. Improve text #538

maxim-belkin commented May 23, 2018

ldko left a comment

ldko May 23, 2018

maxim-belkin May 24, 2018

ldko May 23, 2018

maxim-belkin May 24, 2018

ldko May 23, 2018

maxim-belkin May 24, 2018

ldko May 23, 2018

maxim-belkin May 24, 2018

ldko May 23, 2018

maxim-belkin May 24, 2018

ldko May 23, 2018

maxim-belkin May 24, 2018

alee commented May 23, 2018 •

edited

Loading

maxim-belkin commented May 24, 2018

ldko commented May 24, 2018

maxim-belkin commented May 28, 2018


		We can also change a variable's value by assigning it a new one:
		To change variable's value, we have to assign it a new one:

01-numpy: add a few section headers. Improve text #538

01-numpy: add a few section headers. Improve text #538

Conversation

maxim-belkin commented May 23, 2018

ldko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alee commented May 23, 2018 • edited Loading

maxim-belkin commented May 24, 2018

ldko commented May 24, 2018

maxim-belkin commented May 28, 2018

alee commented May 23, 2018 •

edited

Loading