Skip to content

Commit b4e9f08

Browse files
committed
style: Remove trailing spaces
1 parent 0344345 commit b4e9f08

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/guide/users/checking.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ If you want to also specify the *base* reference to use (instead of the current
2525
```console
2626
$ griffe check mypackage -b HEAD -a 2.0.0
2727
$ griffe check mypackage -b 2.0.0 -a 1.0.0
28-
$ griffe check mypackage -b fix-issue-90 -a 1.2.3
29-
$ griffe check mypackage -b 8afcfd6e
28+
$ griffe check mypackage -b fix-issue-90 -a 1.2.3
29+
$ griffe check mypackage -b 8afcfd6e
3030
```
3131

3232
TIP: **Important:** Remember that the base is the most recent reference, and the one we compare it against is the oldest one.
@@ -160,7 +160,7 @@ greet("hello", "world")
160160

161161
NOTE: Moving required parameters around is not really an API breakage, depending on our definition of API, since this won't raise immediate errors like `TypeError`. The function expects a number of arguments, and the developer passes it this same number of arguments: the contract is fulfilled. But parameters very often have specific meaning, and changing their order will *silently lead* (no immediate error) to incorrect behavior, potentially making it difficult to detect, understand and fix the issue. That is why it is important to warn developers about such changes.
162162

163-
> TIP: **Hint**
163+
> TIP: **Hint**
164164
> If you often add, move or remove parameters, consider making them keyword-only, so that their order doesn't matter.
165165
>
166166
> ```python title="before"
@@ -205,7 +205,7 @@ greet("hello", "world")
205205
greet(prefix="hello", name="world")
206206
```
207207

208-
> TIP: **Hint**
208+
> TIP: **Hint**
209209
> Allow a deprecation period for the removed parameter by swallowing it in a variadic positional parameter, a variadic keyword parameter, or both.
210210
>
211211
> === "positional-only"
@@ -326,7 +326,7 @@ greet(name="tim")
326326
greet2("tim")
327327
```
328328

329-
> TIP: **Hint**
329+
> TIP: **Hint**
330330
> Although it actually is a breaking change, changing your positional or keyword parameters' kind to keyword-only makes your public function more robust to future changes (forward-compatibility).
331331
>
332332
> For functions with lots of optional parameters, and a few (one or two) required parameters, it can be a good idea to accept the required parameters as positional or keyword, while accepting the optional parameters as keyword-only parameters:
@@ -391,7 +391,7 @@ if isinstance(compute_something(7), float):
391391

392392
NOTE: Changing default value of parameters is not really an API breakage, depending on our definition of API, since this won't raise immediate errors like `TypeError`. Not using the parameter still provides the argument with a default value: the contract is fulfilled. But default values very often have specific meaning, and changing them will *silently lead* (no immediate error) to incorrect behavior, potentially making it difficult to detect, understand and fix the issue. That is why it is important to warn developers about such changes.
393393

394-
> TIP: **Hint**
394+
> TIP: **Hint**
395395
> Allow a deprecation period for the old default value by using a sentinel value to detect when the parameter wasn't used by the user:
396396
>
397397
> ```python title="in the coming release"
@@ -445,7 +445,7 @@ def greet(name, prefix):
445445
greet("tiff")
446446
```
447447

448-
> TIP: **Hint**
448+
> TIP: **Hint**
449449
> Allow a deprecation period for the default value by using a sentinel value to detect when the parameter wasn't used by the user:
450450
>
451451
> ```python title="in the coming release"
@@ -489,7 +489,7 @@ def greet(name, prefix):
489489
greet("tiff")
490490
```
491491

492-
> TIP: **Hint**
492+
> TIP: **Hint**
493493
> You can delay (or avoid) and inform your users about the upcoming breakage by temporarily (or permanently) providing a default value for the new parameter:
494494
>
495495
> ```python title="in the coming release"
@@ -530,7 +530,7 @@ from your import module
530530
print(module.special_thing)
531531
```
532532
533-
> TIP: **Hint**
533+
> TIP: **Hint**
534534
> Allow a deprecation period by declaring a module-level `__getattr__` function that returns the given object while warning about its deprecation:
535535
>
536536
> ```python
@@ -606,7 +606,7 @@ if PY_VERSION is None:
606606
607607
NOTE: Changing the value of an attribute is not really an API breakage, depending on our definition of API, since this won't raise immediate errors like `TypeError`. The attribute is still here and accessed: the contract is fulfilled. But developers heavily rely on the value of public attributes, so changing it will lead to incorrect behavior, potentially making it difficult to detect, understand and fix the issue. That is why it is important to warn developers about such changes.
608608
609-
TIP: **Hint**
609+
TIP: **Hint**
610610
Make sure to document the change of value of the attribute in your changelog, particularly the previous and new range of values it can take.
611611
612612
### Class removed base

0 commit comments

Comments
 (0)