Skip to content

Commit 6e39b8e

Browse files
authored
[PyLint Feedback Message Details]: Corrected Munged Links in details.md Files (#81)
* Corrected munged link refrences to documentation in rule details files. per https://forum.exercism.org/t/unparsed-markdown-in-python-analyzer-feedback-for-w0621/48709. * Added missing underscore for italics.
1 parent 7c2b415 commit 6e39b8e

7 files changed

Lines changed: 24 additions & 28 deletions

File tree

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
A common misconception is that [str.strip(\'Hello\')]{.title-ref}
2-
removes the *substring* [\'Hello\']{.title-ref} from the beginning and
3-
end of the string. This is **not** the case. From the
4-
\[documentation\](<https://docs.python.org/3/library/stdtypes.html?highlight=strip#str.strip>):
1+
A common misconception is that [str.strip('Hello')](https://docs.python.org/3.13/library/stdtypes.html#str.strip)
2+
removes the *substring* `'Hello'` from the beginning and
3+
end of the larger lstring. This is **not** the case. From the
4+
[Python documentation](<https://docs.python.org/3/library/stdtypes.html?highlight=strip#str.strip>):
55

6-
\> The chars argument is not a prefix or suffix; rather, all
7-
combinations of its values are stripped.
6+
> _The chars argument is not a prefix or suffix; rather, **all
7+
combinations of its values are stripped.**_
88

9-
Duplicated characters in the [str.strip]{.title-ref} call, besides not
9+
Duplicated characters in the [str.strip()](https://docs.python.org/3.13/library/stdtypes.html#str.strip) call, besides not
1010
having any effect on the actual result, may indicate this
1111
misunderstanding, and lead to future bugs.
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
In Python 2.7, [super()]{.title-ref} has to be called with its own class
2-
and [self]{.title-ref} as arguments ([super(Cat, self)]{.title-ref}),
3-
which can lead to a mix up of parent and child class in the code.
1+
In Python 2.7, [super()](https://docs.python.org/2.7/library/functions.html#super) has to be called with its own class
2+
and `self` as arguments ([super(Cat, self)](https://docs.python.org/2.7/library/functions.html#super)),
3+
which can lead to a mix-up of parent and child class in the code.
44

5-
In Python 3 the recommended way is to call [super()]{.title-ref}
6-
[without]{#without} [arguments]() (see also
7-
[super-with-arguments]{.title-ref}).
5+
In Python 3 the recommended way is to call [super()](https://docs.python.org/3/library/functions.html#super) _without_
6+
[arguments](https://docs.python.org/3/glossary.html#term-argument) (see also
7+
[super-considered-super](https://rhettinger.wordpress.com/2011/05/26/super-considered-super/)).
88

9-
One exception is calling [super()]{.title-ref} on a non-direct parent
9+
One exception is calling `super()` on a non-direct parent
1010
class. This can be used to get a method other than the default method
11-
returned by the [mro()]{.title-ref}.
11+
returned by the [mro()](https://docs.python.org/3/glossary.html#term-method-resolution-order).
Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
11
From [The Python Language Reference -- The import statement](https://docs.python.org/3/reference/simple_stmts.html#the-import-statement):
22

3-
: \"The [public names]{.title-ref} defined by a module are determined
4-
by checking the module\'s namespace for a variable named `__all__`;
5-
if defined, it must be a sequence of strings which are names defined
6-
or imported by that module.\"
3+
> The _public names_ defined by a module are determined by checking the module’s namespace for a variable named `__all__`; if defined, it must be a sequence of strings which are names defined or imported by that module.

lib/common/pylint_data/messages/possibly-used-before-assignment/details.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@ if suffix in "dmy":
1717
handle_date_suffix(suffix)
1818
```
1919

20-
Or, instead of [assert_never()]{.title-ref}, you can call a function
21-
with a return annotation of [Never]{.title-ref} or
22-
[NoReturn]{.title-ref}. Unlike in the general case, where by design
20+
Or, instead of [`assert_never()`](https://typing.python.org/en/latest/guides/unreachable.html#assert-never-and-exhaustiveness-checking), you can call a function
21+
with a return annotation of [`Never` or `NoReturn`](https://typing.python.org/en/latest/guides/unreachable.html#never-and-noreturn). Unlike in the general case, where (by design)
2322
pylint ignores type annotations and does its own static analysis, here,
2423
pylint treats these special annotations like a disable comment.
2524

26-
Pylint currently allows repeating the same test like this, even though
27-
this lets some error cases through, as pylint does not assess the
25+
Pylint currently allows repeating the same test in this way, even though
26+
it lets some error cases through, as pylint does not assess the
2827
intervening code:
2928

3029
``` python

lib/common/pylint_data/messages/redefined-outer-name/details.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
A common issue is that this message is triggered when using
2-
[pytest]{.title-ref}
2+
[pytest](https://docs.pytest.org/en/stable/)
33
[fixtures](https://docs.pytest.org/en/7.1.x/how-to/fixtures.html):
44

55
``` python
@@ -22,5 +22,5 @@ def setup_fixture():
2222
...
2323
```
2424

25-
Alternatively [pylint]{.title-ref} plugins like
25+
Alternatively [pylint](https://www.pylint.org/) plugins like
2626
[pylint-pytest](https://pypi.org/project/pylint-pytest/) can be used.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
This message is emitted when a class which is decorated with
2-
[final]{.title-ref} is subclassed; the decorator indicates that the
2+
[final](https://docs.python.org/3/library/typing.html#typing.final) is subclassed; the decorator indicates that the
33
class is not intended to be extended.
44

55
Note this message can\'t be emitted when using Python \< 3.8.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
The assignment expression (walrus) operator ([:=]{.title-ref}) was
1+
The assignment expression (walrus) operator ([:=](https://docs.python.org/3/reference/expressions.html#assignment-expressions)) was
22
introduced in Python 3.8; to use it, please use a more recent version of
33
Python.

0 commit comments

Comments
 (0)