diff --git a/.pylintrc b/.pylintrc index d917385..3b79138 100644 --- a/.pylintrc +++ b/.pylintrc @@ -2,7 +2,8 @@ [MESSAGES CONTROL] disable=all -enable=dangerous-default-value, +enable=anomalous-backslash-in-string, + dangerous-default-value, inconsistent-return-statements, redefined-argument-from-local, unspecified-encoding, diff --git a/src/wuttjamaican/app.py b/src/wuttjamaican/app.py index 7047f43..83fddba 100644 --- a/src/wuttjamaican/app.py +++ b/src/wuttjamaican/app.py @@ -378,7 +378,7 @@ class AppHandler: :param create: Pass ``True`` here if you want to ensure the returned path exists, creating it if necessary. - :param \*args: Any additional args will be added as child + :param \\*args: Any additional args will be added as child paths for the final value. For instance, assuming ``/srv/envs/poser`` is the virtual diff --git a/src/wuttjamaican/batch.py b/src/wuttjamaican/batch.py index 0d47545..8ae4d36 100644 --- a/src/wuttjamaican/batch.py +++ b/src/wuttjamaican/batch.py @@ -2,7 +2,7 @@ ################################################################################ # # WuttJamaican -- Base package for Wutta Framework -# Copyright © 2023-2024 Lance Edgar +# Copyright © 2023-2025 Lance Edgar # # This file is part of Wutta Framework. # @@ -93,7 +93,7 @@ class BatchHandler(GenericHandler): :param progress: Optional progress indicator factory. - :param \**kwargs: Additional kwargs to pass to the batch + :param \\**kwargs: Additional kwargs to pass to the batch constructor. :returns: New batch; instance of :attr:`model_class`. @@ -372,7 +372,7 @@ class BatchHandler(GenericHandler): :param user: :class:`~wuttjamaican.db.model.auth.User` who might choose to execute the batch. - :param \**kwargs: Execution kwargs for the batch, if known. + :param \\**kwargs: Execution kwargs for the batch, if known. Should be similar to those for :meth:`execute()`. :returns: Text reason to prevent execution, or ``None``. @@ -414,7 +414,7 @@ class BatchHandler(GenericHandler): :param user: Reference to current user who might choose to execute the batch. - :param \**kwargs: Execution kwargs for the batch; should be + :param \\**kwargs: Execution kwargs for the batch; should be similar to those for :meth:`execute()`. :returns: Markdown text describing batch execution. @@ -457,7 +457,7 @@ class BatchHandler(GenericHandler): :param progress: Optional progress indicator factory. - :param \**kwargs: Additional kwargs as needed. These are + :param \\**kwargs: Additional kwargs as needed. These are passed as-is to :meth:`why_not_execute()` and :meth:`execute()`. @@ -494,9 +494,9 @@ class BatchHandler(GenericHandler): :param progress: Optional progress indicator factory. - :param \**kwargs: Additional kwargs which may affect the batch - execution behavior. There are none by default, but some - handlers may declare/use them. + :param \\**kwargs: Additional kwargs which may affect the + batch execution behavior. There are none by default, but + some handlers may declare/use them. :returns: ``None`` by default, but subclass can return whatever it likes, in which case that will be also returned diff --git a/src/wuttjamaican/email.py b/src/wuttjamaican/email.py index 8ad9997..14c5c87 100644 --- a/src/wuttjamaican/email.py +++ b/src/wuttjamaican/email.py @@ -390,7 +390,7 @@ class EmailHandler(GenericHandler): :param default_subject: Optional :attr:`~Message.subject` template/string to use, if config does not specify one. - :param \**kwargs: Any remaining kwargs are passed as-is to + :param \\**kwargs: Any remaining kwargs are passed as-is to :meth:`make_message()`. More on this below. :returns: :class:`~wuttjamaican.email.Message` object. @@ -803,7 +803,7 @@ class EmailHandler(GenericHandler): context = {'data': [1, 2, 3]} app.send_email('foo', context, to='me@example.com', cc='bobby@example.com') - :param \**kwargs: Any remaining kwargs are passed along to + :param \\**kwargs: Any remaining kwargs are passed along to :meth:`make_auto_message()`. So, not used if you provide the ``message``. """ diff --git a/src/wuttjamaican/install.py b/src/wuttjamaican/install.py index 8ca35ec..dfdbb61 100644 --- a/src/wuttjamaican/install.py +++ b/src/wuttjamaican/install.py @@ -268,7 +268,7 @@ class InstallHandler(GenericHandler): :param dbinfo: Dict of DB connection info as obtained from :meth:`get_dbinfo()`. - :param \**kwargs: Extra template context. + :param \\**kwargs: Extra template context. :returns: Dict for global template context. @@ -394,7 +394,7 @@ class InstallHandler(GenericHandler): :param output_path: Path to which output should be written. - :param \**kwargs: Extra context for the template. + :param \\**kwargs: Extra context for the template. Some context will be provided automatically for the template, but these may be overridden via the ``**kwargs``: diff --git a/src/wuttjamaican/people.py b/src/wuttjamaican/people.py index 1cc6fda..3bf133b 100644 --- a/src/wuttjamaican/people.py +++ b/src/wuttjamaican/people.py @@ -47,7 +47,7 @@ class PeopleHandler(GenericHandler): :attr:`~wuttjamaican.db.model.base.Person.full_name` if not specified. - :param \**kwargs: All kwargs are passed as-is to the model + :param \\**kwargs: All kwargs are passed as-is to the model class constructor. :rtype: :class:`~wuttjamaican.db.model.base.Person` diff --git a/src/wuttjamaican/util.py b/src/wuttjamaican/util.py index 6296bb5..843a87c 100644 --- a/src/wuttjamaican/util.py +++ b/src/wuttjamaican/util.py @@ -175,7 +175,7 @@ def make_full_name(*parts): """ Make a "full name" from the given parts. - :param \*parts: Distinct name values which should be joined + :param \\*parts: Distinct name values which should be joined together to make the full name. :returns: The full name.