leapp/0003-Recommend-descriptive-variable-name-for-discarded-va.patch
Petr Stodulka e8307f6fb0 RHEL 8.10: CTC2 candidate - 0
- Add external links to the text version of the generated report file
- Resolves: RHEL-21451
2024-01-12 21:06:40 +01:00

66 lines
3.2 KiB
Diff

From 84f642e8398e5fce24a55bc0bec408ce11b5998d Mon Sep 17 00:00:00 2001
From: Toshio Kuratomi <a.badger@gmail.com>
Date: Tue, 17 Oct 2023 05:09:24 -0700
Subject: [PATCH 3/5] Recommend descriptive variable name for discarded values.
* We tell people not to use `_`. Now we advise them on what to use instead.
* Also fix link syntax in the contribution guide.
---
docs/source/contributing.md | 6 +++---
docs/source/python-coding-guidelines.md | 11 ++++++++++-
2 files changed, 13 insertions(+), 4 deletions(-)
diff --git a/docs/source/contributing.md b/docs/source/contributing.md
index fe69ca0..f0422ee 100644
--- a/docs/source/contributing.md
+++ b/docs/source/contributing.md
@@ -3,7 +3,7 @@
First, thank you for taking your time to contribute to the project.
The following is a set of guidelines for contributing effectively to the Leapp-related repositories
-hosted under the `OS and Application Modernization Group organization <https://github.com/oamg/>`_
+hosted under the [OS and Application Modernization Group organization](https://github.com/oamg/)
on GitHub.
## Code style guidelines
@@ -32,7 +32,7 @@ Before you submit your pull request, consider the following guidelines:
``git checkout -b bug/my-fix-branch master``
* Include documentation that either describe a change to a behavior or the changed capability to an end user.
-* Commit your changes with message conforming to the `Git Commit Messages`_ guidelines.
+* Commit your changes with message conforming to the [Git Commit Messages](#git-commit-messages) guidelines.
* Include tests for the capability you have implemented.
* Make sure your tests pass. We use Jenkins CI for our automated testing.
* Push your branch to GitHub:
@@ -65,7 +65,7 @@ Before you submit your pull request, consider the following guidelines:
* Use the present tense ("Add feature" not "Added feature")
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
* If you are fixing a GitHub issue, include something like 'Closes issue #xyz'
-* For more best practices, read `How to Write a Git Commit Message <https://chris.beams.io/posts/git-commit/>`_
+* For more best practices, read [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)
## Contact
diff --git a/docs/source/python-coding-guidelines.md b/docs/source/python-coding-guidelines.md
index d30f986..3a15579 100644
--- a/docs/source/python-coding-guidelines.md
+++ b/docs/source/python-coding-guidelines.md
@@ -175,4 +175,13 @@ class MyActor(Actor):
### 13. Underscore usage
For leapp and leapp-repository the `_` and `P_` is reserved for localization. Please don't use it for anything else like
-variable-to-be-discarded.
+variable-to-be-discarded. Instead, use a variable name prefixed with `dummy_`. What comes after
+the prefix should describe the data that is being discarded, like so:
+
+``` python
+dummy_scheme, netloc, path, dummy_params, query, fragment = urlparse("scheme://netloc/path;parameters?query#fragment")
+```
+
+Using an informative variable name for discarded values is helpful when a future developer modifies
+the code and needs the discarded information. They can quickly see that the information is already
+available; they just need to rename the variable and start using it.
--
2.43.0