This is an automated email from the ASF dual-hosted git repository. tn pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/tooling-atr-experiments.git
commit 6a418b33e9939b736cbb49ba45be01855c82fa6b Author: Thomas Neidhart <[email protected]> AuthorDate: Mon Mar 10 23:41:41 2025 +0100 add some TBDs to the conventions --- docs/conventions.html | 3 +++ docs/conventions.md | 5 +++++ 2 files changed, 8 insertions(+) diff --git a/docs/conventions.html b/docs/conventions.html index ac697b1..15e2e00 100644 --- a/docs/conventions.html +++ b/docs/conventions.html @@ -18,8 +18,11 @@ <h3>Use the <code>Final</code> type with all constants</h3> <p>This pattern must be followed for top level constants, and should be followed for function and method level constants too. The longer the function, the more important the use of <code>Final</code>.</p> <h3>Prefix global variables with <code>global_</code></h3> +<p>TBD: imho global variables are already implicitly defined by the rules above, uppercase name and no underscore as prefix so no need to add an additional <code>global_</code> prefix, that would just be redundant. +Any variable at module level that is written in uppercase and does not have an underscore is global be definition.</p> <p>Top level variables should be avoided. When their use is necessary, prefix them with <code>global_</code>, using lowercase letters, to ensure clear identification of their scope. Use an underscore prefix too, <code>_global_</code>, when the variable is private.</p> <h3>Import modules as their least significant name part</h3> +<p>TBD: this rule should have some exceptions imho, e.g. typing. The are quite commonly known and used a lot, like Any.</p> <p>Import modules using their least significant name component:</p> <pre><code class="language-python"># Preferred import a.b.c as c diff --git a/docs/conventions.md b/docs/conventions.md index 61ac911..2a4e020 100644 --- a/docs/conventions.md +++ b/docs/conventions.md @@ -32,10 +32,15 @@ This pattern must be followed for top level constants, and should be followed fo ### Prefix global variables with `global_` +TBD: imho global variables are already implicitly defined by the rules above, uppercase name and no underscore as prefix so no need to add an additional `global_` prefix, that would just be redundant. +Any variable at module level that is written in uppercase and does not have an underscore is global be definition. + Top level variables should be avoided. When their use is necessary, prefix them with `global_`, using lowercase letters, to ensure clear identification of their scope. Use an underscore prefix too, `_global_`, when the variable is private. ### Import modules as their least significant name part +TBD: this rule should have some exceptions imho, e.g. typing. The are quite commonly known and used a lot, like Any. + Import modules using their least significant name component: ```python --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
