@@ -16,7 +16,7 @@ our [code of conduct](CODE_OF_CONDUCT.md).
16
16
17
17
### Who Should Contribute?
18
18
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.
20
20
21
21
### How to Contribute
22
22
@@ -72,11 +72,11 @@ If you plan to submit a pull request, please open an issue
72
72
(or comment on an existing thread) first to ensure that effort is not duplicated
73
73
or spent making a change that will not be accepted by the Maintainers.
74
74
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
77
77
code in your PR under ` episodes/fig/source ` .
78
78
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.
80
80
The table gives two terms for each library: ` Term for descriptive text ` which should be
81
81
used when discussing the library in plain English / full sentences and ` Term for code `
82
82
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.
93
93
``` python
94
94
import skimage as ski
95
95
```
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:
97
97
98
98
``` python
99
99
import skimage as ski
100
+
100
101
rr, cc = ski.draw.rectangle(start = (357 , 44 ), end = (740 , 720 ))
101
102
```
102
103
103
104
- For reading and writing images, use the [ imageio] ( https://imageio.readthedocs.io/en/stable/index.html )
104
105
library and avoid use of ` skimage.io ` . For example:
105
106
``` python
106
107
import imageio.v3 as iio
108
+
107
109
chair = iio.imread(uri = " data/chair.jpg" ) # read an image
108
110
iio.imwrite(uri = " data/chair.tif" , image = chair) # write an image
109
111
```
110
112
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.,
112
114
``` python
113
115
""" Python script to load a colour image in grayscale"""
114
116
115
117
chair = iio.imread(uri = " data/chair.jpg" )
116
- gray_chair = skimage .color.rgb2gray(chair)
118
+ gray_chair = ski .color.rgb2gray(chair)
117
119
```
118
120
119
121
### What * Not* to Contribute (General)
0 commit comments