Skip to content

Commit 392d3e7

Browse files
committed
Update py_format.md
1 parent 3ca38d5 commit 392d3e7

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

misc/book/py_format.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Syntax proposal for `.py` files and its relation to Markdown syntax
22

33
`.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.
55

66
These is a syntax description, the least rules are more weighty, but the first rules are more general:
77

88
### Python code
99

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.
1111

1212
**Example**
1313

@@ -24,7 +24,7 @@ print('Hello world')
2424
````
2525

2626
### 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).
2828

2929
**Example**
3030

@@ -44,7 +44,7 @@ The text could be long!
4444
Empty lines are empty text lines, not empty lines inside code blocks.
4545

4646
### 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.
4848

4949
**Example**
5050

@@ -92,7 +92,7 @@ _Hello world_
9292

9393

9494
### 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.
9696

9797
**Example**
9898

0 commit comments

Comments
 (0)