Skip to content

Commit 5e300ff

Browse files
committed
Move docstrings to def lesson. Use triple-quoted doctrings.
1 parent 5221181 commit 5e300ff

3 files changed

Lines changed: 20 additions & 17 deletions

File tree

lessons/beginners/def/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ příkazu, neměl by ti zápis funkce připadat příliš zvláštní:
6262

6363
```python
6464
def zamen(slovo, pozice, novy_znak):
65-
"V daném slově zamění znak na dané pozici za daný nový znak"
65+
"""V daném slově zamění znak na dané pozici za daný nový znak."""
6666
zacatek = slovo[:pozice]
6767
konec = slovo[pozice + 1:]
6868
nove_slovo = zacatek + novy_znak + konec
@@ -78,7 +78,11 @@ Funkce se *definuje* příkazem `def`, za nějž napíšeš jméno funkce,
7878
pak do závorky seznam *parametrů*, které funkce bere, a pak dvojtečku.
7979

8080
Potom následuje odsazené *tělo funkce* – příkazy, které funkce provádí.
81-
Tělo může začít *dokumentačním řetězcem*, který popisuje, co funkce dělá.
81+
82+
Tělo může začít *dokumentačním řetězcem* (angl. *docstring*), který popisuje
83+
co funkce dělá.
84+
To může být jakýkoli řetězec, ale tradičně se uvozuje třemi uvozovkami
85+
(i v případě že je jen jednořádkový).
8286

8387
Příkazem `return` pak můžeš z funkce *vrátit* nějakou hodnotu.
8488

@@ -109,7 +113,7 @@ Následující procedura třeba vypíše skóre daného hráče a k tomu hláš
109113

110114
```python
111115
def napis_hlasku(nazev, skore):
112-
"Popíše skóre. Název má být přivlastňovací přídavné jméno."
116+
"""Popíše skóre. Název má být přivlastňovací přídavné jméno."""
113117

114118
print(nazev, 'skóre je', skore)
115119
if skore > 1000:
@@ -169,7 +173,7 @@ Třeba, chceš-li odpověď „ano“ nebo „ne“:
169173

170174
```python
171175
def ano_nebo_ne(otazka):
172-
"Vrátí True nebo False podle odpovědi uživatele"
176+
"""Vrátí True nebo False podle odpovědi uživatele"""
173177
while True:
174178
odpoved = input(otazka)
175179
if odpoved == 'ano':
@@ -277,7 +281,7 @@ a znamená „nic“.
277281

278282
```python
279283
def nic():
280-
"Tahle funkce nic nedělá"
284+
"""Tahle funkce nic nedělá """
281285

282286
print(nic())
283287
```

lessons/beginners/local-variables/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Podobně skončí s chybou i složitější program:
4949

5050
```python
5151
def zamen(slovo, pozice, novy_znak):
52-
"V daném slově zamění znak na dané pozici za daný nový znak"
52+
"""V daném slově zamění znak na dané pozici za daný nový znak"""
5353
zacatek = slovo[:pozice]
5454
konec = slovo[pozice + 1:]
5555
nove_slovo = zacatek + novy_znak + konec

lessons/beginners/str/index.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -265,23 +265,22 @@ Co se stalo?
265265
Prase kozu potrkalo!'''
266266
```
267267

268-
Víceřádkové řetězce se často používají jako dokumentační řetězce funkcí:
268+
Pozor na to, že pokud je tenhle řetězec
269+
v odsazeném kódu, každý jeho řádek bude začínat
270+
několika mezerami.
271+
(V dokumentačních řetězcích tohle nevadí, tam se s odsazením počítá.)
269272

270273
```python
271-
def vynasob(a, b):
272-
"""Vynásobí argumenty a vrátí výsledek.
274+
cislo = 4
273275

274-
Oba argumenty by měly být čísla.
275-
"""
276+
if cislo > 0:
277+
print("""
278+
Výsledek porovnání:
276279
277-
return a * b
280+
Číslo je kladné.
281+
""")
278282
```
279283

280-
Pozor na to, že pokud je tenhle řetězec
281-
v odsazeném kódu, každý jeho řádek bude začínat
282-
několika mezerami.
283-
(V dokumentačních řetězcích tohle nevadí, tam se s odsazením počítá.)
284-
285284

286285
## Cvičení
287286

0 commit comments

Comments
 (0)