Skip to content

Commit

Permalink
[cleanup] Upgrade more doc following the PyCQA migration
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Sassoulas committed Jun 14, 2023
1 parent 4ebdb5b commit b7d270b
Show file tree
Hide file tree
Showing 32 changed files with 57 additions and 57 deletions.
16 changes: 8 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
.. image:: https://github.com/pylint-dev/pylint/actions/workflows/tests.yaml/badge.svg?branch=main
:target: https://github.com/pylint-dev/pylint/actions

.. image:: https://codecov.io/gh/PyCQA/pylint/branch/main/graph/badge.svg?token=ZETEzayrfk
:target: https://codecov.io/gh/PyCQA/pylint
.. image:: https://codecov.io/gh/pylint-dev/pylint/branch/main/graph/badge.svg?token=ZETEzayrfk
:target: https://codecov.io/gh/pylint-dev/pylint

.. image:: https://img.shields.io/pypi/v/pylint.svg
:alt: Pypi Package version
Expand All @@ -25,15 +25,15 @@
.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen
:target: https://github.com/pylint-dev/pylint

.. image:: https://results.pre-commit.ci/badge/github/PyCQA/pylint/main.svg
:target: https://results.pre-commit.ci/latest/github/PyCQA/pylint/main
.. image:: https://results.pre-commit.ci/badge/github/pylint-dev/pylint/main.svg
:target: https://results.pre-commit.ci/latest/github/pylint-dev/pylint/main
:alt: pre-commit.ci status

.. image:: https://bestpractices.coreinfrastructure.org/projects/6328/badge
:target: https://bestpractices.coreinfrastructure.org/projects/6328
:alt: CII Best Practices

.. image:: https://api.securityscorecards.dev/projects/github.com/PyCQA/pylint/badge
.. image:: https://img.shields.io/ossf-scorecard/github.com/PyCQA/pylint?label=openssf%20scorecard&style=flat
:target: https://api.securityscorecards.dev/projects/github.com/PyCQA/pylint
:alt: OpenSSF Scorecard

Expand Down Expand Up @@ -197,8 +197,8 @@ pylint is, with a few exceptions listed below, `GPLv2 <https://github.com/pylint

The icon files are licensed under the `CC BY-SA 4.0 <https://creativecommons.org/licenses/by-sa/4.0/>`_ license:

- `doc/logo.png <https://raw.githubusercontent.com/PyCQA/pylint/main/doc/logo.png>`_
- `doc/logo.svg <https://raw.githubusercontent.com/PyCQA/pylint/main/doc/logo.svg>`_
- `doc/logo.png <https://raw.githubusercontent.com/pylint-dev/pylint/main/doc/logo.png>`_
- `doc/logo.svg <https://raw.githubusercontent.com/pylint-dev/pylint/main/doc/logo.svg>`_

Support
-------
Expand All @@ -207,7 +207,7 @@ Please check `the contact information`_.

.. _`the contact information`: https://pylint.readthedocs.io/en/latest/contact.html

.. |tideliftlogo| image:: https://raw.githubusercontent.com/PyCQA/pylint/main/doc/media/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White.png
.. |tideliftlogo| image:: https://raw.githubusercontent.com/pylint-dev/pylint/main/doc/media/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White.png
:width: 200
:alt: Tidelift

Expand Down
2 changes: 1 addition & 1 deletion doc/contact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ https://github.com/pylint-dev/pylint
Note that the issue might also be reported in one of Pylint's major dependencies,
astroid:

* https://github.com/PyCQA/astroid
* https://github.com/pylint-dev/astroid

Discord server
--------------
Expand Down
4 changes: 2 additions & 2 deletions doc/development_guide/contributor_guide/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here's a list of links you can check depending on what you want to do:
.. _`on github`: https://github.com/pylint-dev/pylint/issues/new/choose
.. _`Opening an issue`: https://github.com/pylint-dev/pylint/issues/new?assignees=&labels=Needs+triage+%3Ainbox_tray%3A&template=BUG-REPORT.yml
.. _`Making the documentation better`: https://github.com/pylint-dev/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Documentation+%3Agreen_book%3A%22
.. _`Making the error message better`: https://github.com/pylint-dev/pylint/issues?q=is%3Aopen+is%3Aissue+project%3Apycqa%2Fpylint%2F4+
.. _`Making the error message better`: https://github.com/pylint-dev/pylint/issues?q=is%3Aopen%20is%3Aissue%20project%3Apylint-dev%2Fpylint%2F4
.. _`Reproducing bugs and confirming that issues are valid`: https://github.com/pylint-dev/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Needs+reproduction+%3Amag%3A%22%2C%22Cannot+reproduce+%F0%9F%A4%B7%22
.. _`Investigating or debugging complicated issues`: https://github.com/pylint-dev/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Needs+investigation+%F0%9F%94%AC%22
.. _`Designing or specifying a solution`: https://github.com/pylint-dev/pylint/issues?q=is%3Aopen+is%3Aissue+label%3A%22Needs+design+proposal+%3Alock%3A%22%2C%22Needs+specification+%3Aclosed_lock_with_key%3A%22
Expand Down Expand Up @@ -100,7 +100,7 @@ your patch gets accepted:
.. _pytest: https://docs.pytest.org/en/latest/
.. _black: https://github.com/psf/black
.. _isort: https://github.com/PyCQA/isort
.. _astroid: https://github.com/pycqa/astroid
.. _astroid: https://github.com/pylint-dev/astroid


Tips for Getting Started with Pylint Development
Expand Down
4 changes: 2 additions & 2 deletions doc/development_guide/contributor_guide/tests/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If you're testing new changes in astroid you need to also clone astroid_ and ins
with an editable installation alongside pylint as follows::

# Suppose you're in the pylint directory
git clone https://github.com/PyCQA/astroid.git
git clone https://github.com/pylint-dev/astroid.git
python3 -m pip install -e astroid/

You're now using the local astroid in pylint and can control the version with git for example::
Expand All @@ -43,5 +43,5 @@ You're now using the local astroid in pylint and can control the version with gi
git switch my-astroid-dev-branch

.. _pytest-cov: https://pypi.org/project/pytest-cov/
.. _astroid: https://github.com/pycqa/astroid
.. _astroid: https://github.com/pylint-dev/astroid
.. _git: https://git-scm.com/
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ You can find the latest list of repositories and any relevant code for these tes
directory.

.. _pytest-cov: https://pypi.org/project/pytest-cov/
.. _astroid: https://github.com/pycqa/astroid
.. _astroid: https://github.com/pylint-dev/astroid
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,4 @@ module name should be ``{abspath}`` and the file name ``{relpath}``.
.. _tox: https://tox.wiki/en/latest/
.. _pytest: https://docs.pytest.org/en/latest/
.. _pytest-cov: https://pypi.org/project/pytest-cov/
.. _astroid: https://github.com/pycqa/astroid
.. _astroid: https://github.com/pylint-dev/astroid
2 changes: 1 addition & 1 deletion doc/development_guide/how_tos/transform_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,4 @@ an example, any code transformation can be done by plugins.
See `astroid/brain`_ for real life examples of transform plugins.

.. _`warnings.py`: https://hg.python.org/cpython/file/2.7/Lib/warnings.py
.. _`astroid/brain`: https://github.com/PyCQA/astroid/tree/main/astroid/brain
.. _`astroid/brain`: https://github.com/pylint-dev/astroid/tree/main/astroid/brain
2 changes: 1 addition & 1 deletion doc/whatsnew/2/2.1/full.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Release date: 2018-08-01

* Correctly handle the new name of the Python implementation of the ``abc`` module.

Closes PyCQA/astroid#2288
Closes pylint-dev/astroid#2288

* Modules with ``__getattr__`` are exempted by default from ``no-member``

Expand Down
8 changes: 4 additions & 4 deletions doc/whatsnew/2/2.13/full.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ Release date: 2022-03-24
* No longer emit ``no-member`` in for loops that reference ``self`` if the binary operation that
started the for loop uses a ``self`` that is encapsulated in tuples or lists.

Refs PyCQA/astroid#1360
Refs pylint-dev/astroid#1360
Closes #4826

* Output better error message if unsupported file formats are used with ``pyreverse``.
Expand Down Expand Up @@ -389,7 +389,7 @@ Release date: 2022-03-24
* Fixed a crash involving a ``NewType`` named with an f-string.

Closes #5770
Ref PyCQA/astroid#1400
Ref pylint-dev/astroid#1400

* Improved ``bad-open-mode`` message when providing ``None`` to the ``mode``
argument of an ``open()`` call.
Expand All @@ -406,13 +406,13 @@ Release date: 2022-03-24
the class itself.

Closes #5408
Ref PyCQA/astroid#1392
Ref pylint-dev/astroid#1392

* Fixed false positive for ``unused-argument`` when a method overridden in a subclass
does nothing with the value of a keyword-only argument.

Closes #5771
Ref PyCQA/astroid#1382
Ref pylint-dev/astroid#1382

* The issue template for crashes is now created for crashes which were previously not covered
by this mechanism.
Expand Down
8 changes: 4 additions & 4 deletions doc/whatsnew/2/2.13/summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Other Changes
* No longer emit ``no-member`` in for loops that reference ``self`` if the binary operation that
started the for loop uses a ``self`` that is encapsulated in tuples or lists.

Refs PyCQA/astroid#1360
Refs pylint-dev/astroid#1360
Closes #4826

* Fix matching ``--notes`` options that end in a non-word character.
Expand Down Expand Up @@ -295,13 +295,13 @@ Other Changes
the class itself.

Closes #5408
RefsPyCQA/astroid#1392
Refspylint-dev/astroid#1392

* Fixed false positive for ``unused-argument`` when a method overridden in a subclass
does nothing with the value of a keyword-only argument.

Closes #5771
RefsPyCQA/astroid#1382
Refspylint-dev/astroid#1382

* Optimize parsing of long lines when ``missing-final-newline`` is enabled.

Expand Down Expand Up @@ -343,7 +343,7 @@ Other Changes
* Fixed a crash involving a ``NewType`` named with an f-string.

Closes #5770
RefsPyCQA/astroid#1400
Refspylint-dev/astroid#1400

* Improved ``bad-open-mode`` message when providing ``None`` to the ``mode``
argument of an ``open()`` call.
Expand Down
2 changes: 1 addition & 1 deletion doc/whatsnew/2/2.3/full.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Release date: 2019-02-27
Doesn't make that much sense for ``pylint`` itself, which is why we're handling the
exception here, rather than in ``astroid``

Closes PyCQA/astroid#644
Closes pylint-dev/astroid#644

* Added a new command line option ``list-groups`` for listing all the check groups ``pylint`` knows about.

Expand Down
4 changes: 2 additions & 2 deletions doc/whatsnew/2/2.9/full.rst
Original file line number Diff line number Diff line change
Expand Up @@ -304,12 +304,12 @@ Release date: 2021-06-29

* Fix false-positive ``no-member`` with generic base class

Closes PyCQA/astroid#942
Closes pylint-dev/astroid#942

* Fix ``assigning-non-slot`` false-positive with base that inherits from ``typing.Generic``

Closes #4509
Closes PyCQA/astroid#999
Closes pylint-dev/astroid#999

* New checker ``invalid-all-format``. Emitted when ``__all__`` has an invalid format,
i.e. isn't a ``tuple`` or ``list``.
Expand Down
2 changes: 1 addition & 1 deletion pylint/checkers/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ def is_defined_before(var_node: nodes.Name) -> bool:
defnode_scope = defnode.scope()
if isinstance(defnode_scope, COMP_NODE_TYPES + (nodes.Lambda,)):
# Avoid the case where var_node_scope is a nested function
# FunctionDef is a Lambda until https://github.com/PyCQA/astroid/issues/291
# FunctionDef is a Lambda until https://github.com/pylint-dev/astroid/issues/291
if isinstance(defnode_scope, nodes.FunctionDef):
var_node_scope = var_node.scope()
if var_node_scope is not defnode_scope and isinstance(
Expand Down
2 changes: 1 addition & 1 deletion pylint/checkers/variables.py
Original file line number Diff line number Diff line change
Expand Up @@ -2429,7 +2429,7 @@ def _loopvar_name(self, node: astroid.Name) -> None:
# the variable is not defined.
scope = node.scope()
# FunctionDef subclasses Lambda due to a curious ontology. Check both.
# See https://github.com/PyCQA/astroid/issues/291
# See https://github.com/pylint-dev/astroid/issues/291
# TODO: Revisit when astroid 3.0 includes the change
if isinstance(scope, nodes.Lambda) and any(
asmt.scope().parent_of(scope) for asmt in astmts
Expand Down
2 changes: 1 addition & 1 deletion script/check_newsfragments.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
ISSUES_KEYWORDS = "|".join(VALID_ISSUES_KEYWORDS)
VALID_CHANGELOG_PATTERN = (
rf"(?P<description>(.*\n)*(.*\.\n))\n(?P<ref>({ISSUES_KEYWORDS})"
r" (PyCQA/astroid)?#(?P<issue>\d+))"
r" (pylint-dev/astroid)?#(?P<issue>\d+))"
)
VALID_CHANGELOG_COMPILED_PATTERN: Pattern[str] = re.compile(
VALID_CHANGELOG_PATTERN, flags=re.MULTILINE
Expand Down
2 changes: 1 addition & 1 deletion tests/functional/a/assigning/assigning_non_slot_4509.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Slots with base that inherits from 'Generic'
# https://github.com/pylint-dev/pylint/issues/4509
# https://github.com/PyCQA/astroid/issues/999
# https://github.com/pylint-dev/astroid/issues/999

from typing import Generic, TypeVar
T = TypeVar("T")
Expand Down
2 changes: 1 addition & 1 deletion tests/functional/d/dataclass/dataclass_typecheck.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Tests for dataclass attributes with basic type annotations.
Tests for regressions from https://github.com/PyCQA/astroid/pull/1126
Tests for regressions from https://github.com/pylint-dev/astroid/pull/1126
"""

# pylint: disable=missing-docstring,too-few-public-methods,pointless-statement,redefined-builtin, fixme
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Test that a recursion error does not happen
https://github.com/PyCQA/astroid/issues/623
https://github.com/pylint-dev/astroid/issues/623
"""
from os import path

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/r/regression_02/regression_5030.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Regression in astroid on ClassDef inference with two test cases.
Fixed in https://github.com/PyCQA/astroid/pull/1181"""
Fixed in https://github.com/pylint-dev/astroid/pull/1181"""

from typing import Tuple, Type
from typing import Dict, List, Any
Expand Down
2 changes: 1 addition & 1 deletion tests/functional/r/regression_02/regression_5048.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Crash regression in astroid on Compare node inference
Fixed in https://github.com/PyCQA/astroid/pull/1185"""
Fixed in https://github.com/pylint-dev/astroid/pull/1185"""
# pylint: disable=missing-docstring, broad-exception-raised


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
See also:
https://github.com/pylint-dev/pylint/issues/2955
https://github.com/PyCQA/astroid/pull/1321
https://github.com/pylint-dev/astroid/pull/1321
"""

# pylint: disable=unused-import, deprecated-module
Expand Down
4 changes: 2 additions & 2 deletions tests/functional/r/regression_02/regression_enum_1734.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Regression test for https://github.com/PyCQA/astroid/pull/1734
# Regression test for https://github.com/pylint-dev/astroid/pull/1734
# The following should lint just fine
# Fixed in https://github.com/PyCQA/astroid/pull/1743
# Fixed in https://github.com/pylint-dev/astroid/pull/1743

# pylint: disable=missing-docstring,invalid-name

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/s/super/super_checks.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def __init__(self):



# Regression for PyCQA/pylint/issues/773
# Regression for pylint-dev/pylint/issues/773
import subprocess

# The problem was related to astroid not filtering statements
Expand Down
2 changes: 1 addition & 1 deletion tests/functional/t/typing_generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class Impl(Base[str]):
"""Impl"""


# https://github.com/PyCQA/astroid/issues/942
# https://github.com/pylint-dev/astroid/issues/942
Anything = TypeVar("Anything")
MoreSpecific = TypeVar("MoreSpecific", str, int)

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/u/unused/unused_variable.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ def func4():


def main(lst):
"""https://github.com/PyCQA/astroid/pull/1111#issuecomment-890367609"""
"""https://github.com/pylint-dev/astroid/pull/1111#issuecomment-890367609"""
try:
raise ValueError
except ValueError as e: # [unused-variable]
Expand Down
2 changes: 1 addition & 1 deletion tests/primer/packages_to_prime.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"astroid": {
"branch": "main",
"directories": ["astroid"],
"url": "https://github.com/PyCQA/astroid",
"url": "https://github.com/pylint-dev/astroid",
"pylintrc_relpath": "pylintrc"
},
"black": {
Expand Down
6 changes: 3 additions & 3 deletions tests/testutils/_primer/fixtures/message_changed/expected.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@



**Effect on [astroid](https://github.com/PyCQA/astroid):**
**Effect on [astroid](https://github.com/pylint-dev/astroid):**
The following messages are now emitted:

<details>

1) locally-disabled:
*Locally disabling redefined-builtin [we added some text in the message] (W0622)*
https://github.com/PyCQA/astroid/blob/123456789abcdef/astroid/__init__.py#L91
https://github.com/pylint-dev/astroid/blob/123456789abcdef/astroid/__init__.py#L91

</details>

Expand All @@ -19,7 +19,7 @@ The following messages are no longer emitted:

1) locally-disabled:
*Locally disabling redefined-builtin (W0622)*
https://github.com/PyCQA/astroid/blob/123456789abcdef/astroid/__init__.py#L91
https://github.com/pylint-dev/astroid/blob/123456789abcdef/astroid/__init__.py#L91

</details>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@



**Effect on [astroid](https://github.com/PyCQA/astroid):**
**Effect on [astroid](https://github.com/pylint-dev/astroid):**
The following messages are now emitted:

<details>

1) locally-disabled:
*Locally disabling redefined-builtin [we added some text in the message] (W0622)*
https://github.com/PyCQA/astroid/blob/123456789abcdef/astroid/__init__.py#L91
https://github.com/pylint-dev/astroid/blob/123456789abcdef/astroid/__init__.py#L91

</details>

The following message...
The followi...

*This comment was truncated because GitHub allows only 525 characters in a comment.*

Expand Down
4 changes: 2 additions & 2 deletions tests/testutils/_primer/fixtures/message_changed/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"column": 0,
"endLine": null,
"endColumn": null,
"path": "tests/.pylint_primer_tests/PyCQA/astroid/astroid/__init__.py",
"path": "tests/.pylint_primer_tests/pylint-dev/astroid/astroid/__init__.py",
"symbol": "locally-disabled",
"message": "Locally disabling redefined-builtin (W0622)",
"message-id": "I0011"
Expand All @@ -23,7 +23,7 @@
"column": 0,
"endLine": null,
"endColumn": null,
"path": "tests/.pylint_primer_tests/PyCQA/astroid/astroid/__init__.py",
"path": "tests/.pylint_primer_tests/pylint-dev/astroid/astroid/__init__.py",
"symbol": "unknown-option-value",
"message": "Unknown option value for 'disable', expected a valid pylint message and got 'Ellipsis'",
"message-id": "W0012"
Expand Down
Loading

0 comments on commit b7d270b

Please sign in to comment.