Skip to content

Commit 5168032

Browse files
authored
Fixing doc references after click 8.2 release (#6880)
`click` released v8.2.0 and by that broke the references to their doc. We pinned `click~=8.1` so we still need to reference the old API but because `click` only keeps one version of the documentation, we cannot reference a different API. Thus we reference the functions by the GitHub link for v8.1.0.
1 parent b618cb7 commit 5168032

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/aiida/cmdline/groups/verdi.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,18 +88,20 @@ class VerdiCommand(click.Command):
8888
is printed after the prompting for parameters, which for interactive commands mean the deprecation warning comes too
8989
late, when the user has already provided all prompts.
9090
91-
Here, the :meth:`click.Command.parse_args` method is overridden, which is called before the interactive options
92-
start to prompt, such that the deprecation warning can be printed. The :meth:`click.Command.invoke` method is also
93-
overridden in order to skip the printing of the deprecation message handled by ``click`` as that would result in
94-
the deprecation message being printed twice.
91+
Here, the `click.Command.parse_args
92+
<https://github.com/pallets/click/blob/f8d811e5d5644aca8d32eebff196bf7c659ebf45/src/click/core.py#L1369>`_ method is
93+
overridden, which is called before the interactive options start to prompt, such that the deprecation warning can be
94+
printed. The :meth:`click.Command.invoke` method is also overridden in order to skip the printing of the deprecation
95+
message handled by ``click`` as that would result in the deprecation message being printed twice.
9596
"""
9697

9798
def parse_args(self, ctx: click.Context, args: t.List[str]) -> t.List[str]:
9899
"""Given a context and a list of arguments this creates the parser and parses the arguments.
99100
100101
Then context is modified as necessary.
101102
102-
This is automatically invoked by :meth:`click.BaseCommand.make_context`.
103+
This is automatically invoked by `click.BaseCommand.make_context
104+
<https://github.com/pallets/click/blob/f8d811e5d5644aca8d32eebff196bf7c659ebf45/src/click/core.py#L884>`_.
103105
"""
104106
if self.deprecated:
105107
# We are abusing click.Command `deprecated` member variable by using a

0 commit comments

Comments
 (0)