From 563e5a90d4d072fb5a48c9e3bd76eb525e2f4693 Mon Sep 17 00:00:00 2001 From: Yanks Yoon <37652070+yanksyoon@users.noreply.github.com> Date: Thu, 16 Jan 2025 22:13:10 +0800 Subject: [PATCH] docs: update docstring for maven plugin (#971) Co-authored-by: Callahan Co-authored-by: Alex Lowe --- craft_parts/plugins/maven_plugin.py | 4 ++-- docs/common/craft-parts/craft-parts.wordlist.txt | 1 + docs/reference/changelog.rst | 4 ++++ 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/craft_parts/plugins/maven_plugin.py b/craft_parts/plugins/maven_plugin.py index 9b7e7e467..39244d78d 100644 --- a/craft_parts/plugins/maven_plugin.py +++ b/craft_parts/plugins/maven_plugin.py @@ -58,8 +58,8 @@ def validate_environment( :param part_dependencies: A list of the parts this part depends on. - :raises PluginEnvironmentValidationError: If go is invalid - and there are no parts named go. + :raises PluginEnvironmentValidationError: If maven is invalid + and there are no parts named maven-deps. """ version = self.validate_dependency( dependency="mvn", diff --git a/docs/common/craft-parts/craft-parts.wordlist.txt b/docs/common/craft-parts/craft-parts.wordlist.txt index 9a19f2f20..3e2d13d3a 100644 --- a/docs/common/craft-parts/craft-parts.wordlist.txt +++ b/docs/common/craft-parts/craft-parts.wordlist.txt @@ -338,6 +338,7 @@ distro distros dl dnf +docstring dotnet dst emacs diff --git a/docs/reference/changelog.rst b/docs/reference/changelog.rst index 6647304a7..3c669509f 100644 --- a/docs/reference/changelog.rst +++ b/docs/reference/changelog.rst @@ -10,6 +10,10 @@ Bug fixes: - Make sure the :ref:`uv plugin` is re-entrant on source changes. +Documentation: + +- Correct the Maven plugin docstring to refer to Maven from Go. + 2.2.1 (2024-12-19) ------------------