@@ -16,7 +16,7 @@ our [code of conduct](CODE_OF_CONDUCT.md).
1616
1717### Who Should Contribute?
1818
19- Contributions to this curriculum are welcome from anyone with an interest in the project.
19+ Contributions to this lesson are welcome from anyone with an interest in the project.
2020
2121### How to Contribute
2222
@@ -72,11 +72,11 @@ If you plan to submit a pull request, please open an issue
7272(or comment on an existing thread) first to ensure that effort is not duplicated
7373or spent making a change that will not be accepted by the Maintainers.
7474
75- #### Style / content guidelines
76- - If you add an image / figure that was generated from python code, please include this
75+ #### Content / style guidelines
76+ - If you add an image / figure that was generated from Python code, please include this
7777 code in your PR under ` episodes/fig/source ` .
7878
79- - Use the terms in the table below, when referring to python libraries within the lesson.
79+ - Use the terms in the table below, when referring to Python libraries within the lesson.
8080 The table gives two terms for each library: ` Term for descriptive text ` which should be
8181 used when discussing the library in plain English / full sentences and ` Term for code `
8282 which should be used when referring to code (and within code).
@@ -93,27 +93,29 @@ or spent making a change that will not be accepted by the Maintainers.
9393 ``` python
9494 import skimage as ski
9595 ```
96- If you need a specific sub-module, reference this explicitly based on ` ski ` . For example:
96+ Therefore, to access specific functions, you need to use their submodule name . For example:
9797
9898 ``` python
9999 import skimage as ski
100+
100101 rr, cc = ski.draw.rectangle(start = (357 , 44 ), end = (740 , 720 ))
101102 ```
102103
103104- For reading and writing images, use the [ imageio] ( https://imageio.readthedocs.io/en/stable/index.html )
104105 library and avoid use of ` skimage.io ` . For example:
105106 ``` python
106107 import imageio.v3 as iio
108+
107109 chair = iio.imread(uri = " data/chair.jpg" ) # read an image
108110 iio.imwrite(uri = " data/chair.tif" , image = chair) # write an image
109111 ```
110112
111- - Comments providing an overall description of a code snippet, should use triple quotes ` """ ` e.g.
113+ - Comments providing an overall description of a code snippet should use triple quotes ` """ ` , e.g.,
112114 ``` python
113115 """ Python script to load a colour image in grayscale"""
114116
115117 chair = iio.imread(uri = " data/chair.jpg" )
116- gray_chair = skimage .color.rgb2gray(chair)
118+ gray_chair = ski .color.rgb2gray(chair)
117119 ```
118120
119121### What * Not* to Contribute (General)
0 commit comments