Some doc fixes

smurfix · smurfix · commit 355fa9e8dd7f · 2021-02-09T11:14:38.000+01:00
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,4 +1,4 @@
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 asyncclick 8
 ------------
diff --git a/docs/advanced.rst b/docs/advanced.rst
@@ -1,7 +1,7 @@
 Advanced Patterns
 =================
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 In addition to common functionality that is implemented in the library
 itself, there are countless patterns that can be implemented by extending
@@ -390,7 +390,7 @@ In some situations it's helpful to understand whether or not an option
 or parameter came from the command line, the environment, the default
 value, or :attr:`Context.default_map`. The
 :meth:`Context.get_parameter_source` method can be used to find this
-out. It will return a member of the :class:`~click.core.ParameterSource`
+out. It will return a member of the :class:`~asyncclick.core.ParameterSource`
 enum.
 
 .. click:example::
@@ -447,7 +447,7 @@ Ordinarily, it would be used with the ``with`` statement:
 However, a ``with`` block in a group would exit and close the database
 before it could be used by a subcommand.
 
-Instead, use the context's :meth:`~click.Context.with_resource` method
+Instead, use the context's :meth:`~asyncclick.Context.with_resource` method
 to enter the context manager and return the resource. When the group and
 any subcommands finish, the context's resources are cleaned up.
 
@@ -466,12 +466,12 @@ any subcommands finish, the context's resources are cleaned up.
         for entry in obj.db.query(...):
             click.echo(entry)
 
-There is also a :meth:`~click.Context.with_async_resource` method
+There is also a :meth:`~asyncclick.Context.with_async_resource` method
 if the resource must be used asynchronously.
 
 If the resource isn't a context manager, usually it can be wrapped in
 one using something from :mod:`contextlib`. If that's not possible, use
-the context's :meth:`~click.Context.call_on_close` method to register a
+the context's :meth:`~asyncclick.Context.call_on_close` method to register a
 cleanup function.
 
 .. code-block:: python
diff --git a/docs/api.rst b/docs/api.rst
@@ -183,7 +183,7 @@ Shell Completion
 See :doc:`/shell-completion` for information about enabling and
 customizing Click's shell completion system.
 
-.. currentmodule:: click.shell_completion
+.. currentmodule:: asyncclick.shell_completion
 
 .. autoclass:: CompletionItem
 
@@ -197,7 +197,7 @@ customizing Click's shell completion system.
 Testing
 -------
 
-.. currentmodule:: click.testing
+.. currentmodule:: asyncclick.testing
 
 .. autoclass:: CliRunner
    :members:
diff --git a/docs/arguments.rst b/docs/arguments.rst
@@ -3,7 +3,7 @@
 Arguments
 =========
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 Arguments work similarly to :ref:`options <options>` but are positional.
 They also only support a subset of the features of options due to their
diff --git a/docs/commands.rst b/docs/commands.rst
@@ -1,7 +1,7 @@
 Commands and Groups
 ===================
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 The most important feature of Click is the concept of arbitrarily nesting
 command line utilities.  This is implemented through the :class:`Command`
diff --git a/docs/complex.rst b/docs/complex.rst
@@ -3,7 +3,7 @@
 Complex Applications
 ====================
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 Click is designed to assist with the creation of complex and simple CLI tools
 alike.  However, the power of its design is the ability to arbitrarily nest
diff --git a/docs/conf.py b/docs/conf.py
@@ -2,17 +2,17 @@
 from pallets_sphinx_themes import get_version
 from pallets_sphinx_themes import ProjectLink
 
-import click._compat
+import asyncclick._compat
 
 # compat until pallets-sphinx-themes is updated
 click._compat.text_type = str
 
 # Project --------------------------------------------------------------
 
-project = "Click"
-copyright = "2014 Pallets"
+project = "AsyncClick"
+copyright = "2014 Pallets, 2019 Matthias Urlichs"
 author = "Pallets"
-release, version = get_version("Click", version_length=1)
+release, version = get_version("asyncclick", version_length=1)
 
 # General --------------------------------------------------------------
 
@@ -26,7 +26,7 @@
     "sphinx_tabs.tabs",
 ]
 intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
-issues_github_path = "pallets/click"
+issues_github_path = "python-trio/asyncclick"
 
 # HTML -----------------------------------------------------------------
 
@@ -39,6 +39,7 @@
         ProjectLink("PyPI releases", "https://pypi.org/project/click/"),
         ProjectLink("Source Code", "https://github.com/pallets/click/"),
         ProjectLink("Issue Tracker", "https://github.com/pallets/click/issues/"),
+        ProjectLink("AsyncClick Fork", "https://github.com/python-trio/asyncclick/"),
     ]
 }
 html_sidebars = {
@@ -49,9 +50,9 @@
 html_static_path = ["_static"]
 html_favicon = "_static/click-icon.png"
 html_logo = "_static/click-logo-sidebar.png"
-html_title = f"Click Documentation ({version})"
+html_title = f"AsyncClick Documentation ({version})"
 html_show_sourcelink = False
 
 # LaTeX ----------------------------------------------------------------
 
-latex_documents = [(master_doc, f"Click-{version}.tex", html_title, author, "manual")]
+latex_documents = [(master_doc, f"AsyncClick-{version}.tex", html_title, author, "manual")]
diff --git a/docs/documentation.rst b/docs/documentation.rst
@@ -1,7 +1,7 @@
 Documenting Scripts
 ===================
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 Click makes it very easy to document your command line tools.  First of
 all, it automatically generates help pages for you.  While these are
diff --git a/docs/exceptions.rst b/docs/exceptions.rst
@@ -1,7 +1,7 @@
 Exception Handling
 ==================
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 Click internally uses exceptions to signal various error conditions that
 the user of the application might have caused.  Primarily this is things
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,11 +19,12 @@ It aims to make the process of writing command line tools quick and fun
 while also preventing any frustration caused by the inability to implement
 an intended CLI API.
 
-Click in three points:
+AsyncClick in four points:
 
 -   arbitrary nesting of commands
 -   automatic help page generation
 -   supports lazy loading of subcommands at runtime
+-   seamlessly use async-enabled command and subcommand handlers
 
 What does it look like?  Here is an example of a simple Click program:
 
@@ -64,6 +65,16 @@ You can get the library directly from PyPI::
 Documentation
 -------------
 
+.. note::
+
+    asyncclick closely tracks click's releases and development.
+    In order to streamline this process, the documentation was changed
+    as lightly as possible. Thus, the author decided not to mangle the
+    text and did not replace ``click`` with ``asyncclick``.
+
+    Please adjust all ``import click`` statements to
+    ``import asyncclick as click``, or apply similar changes, as required.
+
 This part of the documentation guides you through all of the library's
 usage patterns.
 
diff --git a/docs/options.rst b/docs/options.rst
@@ -3,7 +3,7 @@
 Options
 =======
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 Adding options to commands can be accomplished by the :func:`option`
 decorator.  Since options can come in various different versions, there
diff --git a/docs/parameters.rst b/docs/parameters.rst
@@ -1,7 +1,7 @@
 Parameters
 ==========
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 Click supports two types of parameters for scripts: options and arguments.
 There is generally some confusion among authors of command line scripts of
diff --git a/docs/prompts.rst b/docs/prompts.rst
@@ -1,7 +1,7 @@
 User Input Prompts
 ==================
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 Click supports prompts in two different places.  The first is automated
 prompts when the parameter handling happens, and the second is to ask for
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -1,7 +1,7 @@
 Quickstart
 ==========
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 You can get the library directly from PyPI::
 
diff --git a/docs/shell-completion.rst b/docs/shell-completion.rst
@@ -1,4 +1,4 @@
-.. currentmodule:: click.shell_completion
+.. currentmodule:: asyncclick.shell_completion
 
 Shell Completion
 ================
@@ -118,8 +118,8 @@ for the changes to be loaded.
 Custom Type Completion
 ----------------------
 
-When creating a custom :class:`~click.ParamType`, override its
-:meth:`~click.ParamType.shell_complete` method to provide shell
+When creating a custom :class:`~asyncclick.ParamType`, override its
+:meth:`~asyncclick.ParamType.shell_complete` method to provide shell
 completion for parameters with the type. The method must return a list
 of :class:`~CompletionItem` objects. Besides the value, these objects
 hold metadata that shell support might use. The built-in implementations
diff --git a/docs/testing.rst b/docs/testing.rst
@@ -1,7 +1,7 @@
 Testing Click Applications
 ==========================
 
-.. currentmodule:: click.testing
+.. currentmodule:: asyncclick.testing
 
 For basic testing, Click provides the :mod:`click.testing` module which
 provides test functionality that helps you invoke command line
diff --git a/docs/unicode-support.rst b/docs/unicode-support.rst
@@ -1,7 +1,7 @@
 Unicode Support
 ===============
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 Click has to take extra care to support Unicode text in different
 environments.
diff --git a/docs/utils.rst b/docs/utils.rst
@@ -1,7 +1,7 @@
 Utilities
 =========
 
-.. currentmodule:: click
+.. currentmodule:: asyncclick
 
 Besides the functionality that Click provides to interface with argument
 parsing and handling, it also provides a bunch of addon functionality that
diff --git a/requirements/dev.in b/requirements/dev.in
@@ -3,3 +3,4 @@
 pip-tools
 pre-commit
 tox
+anyio
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -4,6 +4,7 @@
 #
 #    pip-compile requirements/dev.in
 #
+anyio
 alabaster==0.7.12
     # via sphinx
 appdirs==1.4.4
diff --git a/requirements/docs.in b/requirements/docs.in
@@ -3,3 +3,4 @@ Sphinx
 sphinx-issues
 sphinxcontrib-log-cabinet
 sphinx-tabs
+anyio
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -4,6 +4,7 @@
 #
 #    pip-compile requirements/docs.in
 #
+anyio
 alabaster==0.7.12
     # via sphinx
 babel==2.8.0
diff --git a/src/click/core.py b/src/click/core.py
@@ -515,7 +515,7 @@ def get_language():
         return self._meta
 
     def make_formatter(self):
-        """Creates the :class:`~click.HelpFormatter` for the help and
+        """Creates the :class:`~asyncclick.HelpFormatter` for the help and
         usage output.
 
         To quickly customize the formatter class used without overriding
@@ -774,7 +774,7 @@ def set_parameter_source(self, name, source):
         from which the value of the parameter was obtained.
 
         :param name: The name of the parameter.
-        :param source: A member of :class:`~click.core.ParameterSource`.
+        :param source: A member of :class:`~asyncclick.core.ParameterSource`.
         """
         self._parameter_source[name] = source
 
@@ -784,7 +784,7 @@ def get_parameter_source(self, name):
 
         This can be useful for determining when a user specified a value
         on the command line that is the same as the default value. It
-        will be :attr:`~click.core.ParameterSource.DEFAULT` only if the
+        will be :attr:`~asyncclick.core.ParameterSource.DEFAULT` only if the
         value was actually taken from the default.
 
         :param name: The name of the parameter.
@@ -1841,7 +1841,7 @@ class Parameter:
     :param shell_complete: A function that returns custom shell
         completions. Used instead of the param's type completion if
         given. Takes ``ctx, param, incomplete`` and must return a list
-        of :class:`~click.shell_completion.CompletionItem` or a list of
+        of :class:`~asyncclick.shell_completion.CompletionItem` or a list of
         strings.
 
     .. versionchanged:: 8.0
@@ -2165,7 +2165,7 @@ def shell_complete(self, ctx, incomplete):
         """Return a list of completions for the incomplete value. If a
         ``shell_complete`` function was given during init, it is used.
         Otherwise, the :attr:`type`
-        :meth:`~click.types.ParamType.shell_complete` function is used.
+        :meth:`~asyncclick.types.ParamType.shell_complete` function is used.
 
         :param ctx: Invocation context for this command.
         :param incomplete: Value being completed. May be empty.
diff --git a/src/click/parser.py b/src/click/parser.py
@@ -222,12 +222,12 @@ class OptionParser:
     implement features that are implemented on a higher level (such as
     types or defaults).
 
-    :param ctx: optionally the :class:`~click.Context` where this parser
+    :param ctx: optionally the :class:`~asyncclick.Context` where this parser
                 should go with.
     """
 
     def __init__(self, ctx=None):
-        #: The :class:`~click.Context` for this parser.  This might be
+        #: The :class:`~asyncclick.Context` for this parser.  This might be
         #: `None` for some advanced use cases.
         self.ctx = ctx
         #: This controls how the parser deals with interspersed arguments.
diff --git a/src/click/testing.py b/src/click/testing.py
@@ -298,7 +298,7 @@ async def invoke(
     ):
         """Invokes a command in an isolated environment.  The arguments are
         forwarded directly to the command line script, the `extra` keyword
-        arguments are passed to the :meth:`~clickpkg.Command.main` function of
+        arguments are passed to the :meth:`~asyncclickpkg.Command.main` function of
         the command.
 
         This returns a :class:`Result` object.
diff --git a/src/click/types.py b/src/click/types.py
@@ -109,7 +109,7 @@ def fail(self, message, param=None, ctx=None):
 
     def shell_complete(self, ctx, param, incomplete):
         """Return a list of
-        :class:`~click.shell_completion.CompletionItem` objects for the
+        :class:`~asyncclick.shell_completion.CompletionItem` objects for the
         incomplete value. Most types do not provide completions, but
         some do, and this allows custom types to provide custom
         completions as well.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-.. currentmodule:: click`
	`1`	`+.. currentmodule:: asyncclick`
`2`	`2`
`3`	`3`	`asyncclick 8`
`4`	`4`	`------------`