You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: misc/book/py_format.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# Syntax proposal for `.py` files and its relation to Markdown syntax
2
2
3
3
`.py` files under `scientific_python/` directory are valid Python 2/3 modules.
4
-
These files are full of comments that uses Markdown-like syntax.
4
+
These files are full of comments that use Markdown-like syntax.
5
5
6
6
These is a syntax description, the least rules are more weighty, but the first rules are more general:
7
7
8
8
### Python code
9
9
10
-
These strings start with any symbol except `#` and should be converted to code blocks.
10
+
These lines start with any symbol except `#` and should be converted to code blocks.
11
11
12
12
**Example**
13
13
@@ -24,7 +24,7 @@ print('Hello world')
24
24
````
25
25
26
26
### Text
27
-
Text is located in comments that start with `# ` (with trailing space).
27
+
Text is located in comment lines that start with `# ` (with trailing space).
28
28
29
29
**Example**
30
30
@@ -44,7 +44,7 @@ The text could be long!
44
44
Empty lines are empty text lines, not empty lines inside code blocks.
45
45
46
46
### Part of Markdown syntax inside text
47
-
Text can contain little parts of Markdown syntax, it just shouldn't be cleaned.
47
+
Text can contain little parts of Markdown syntax, it just shouldn't be cleaned during transformation.
48
48
49
49
**Example**
50
50
@@ -92,7 +92,7 @@ _Hello world_
92
92
93
93
94
94
### Commented code
95
-
Sometimes it is useful to comment not working / bad style code. Such strings start with `# >>>` (with trailing space). In this case ` >>>` (with one of spaces) should be removed and string should be added to the surrounding code block.
95
+
Sometimes it is useful to comment code that doesn't work or has a bad style. Such strings start with `# >>>` (with trailing space). In this case ` >>>` (with one of the spaces) should be removed and string should be added to the surrounding code block.
0 commit comments