Refactor variable names for consistency: update casing for generator … #142
+1,509
−1,121
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…base and use_directory_urls in MkDoxy plugin and GeneratorSnippets
…ions and improve readability; add new generator_snippets module for handling Doxygen snippets
…; improve logging format in Doxygen; update type hints in Cache and CLI functions
…ures, improve logging format, and standardize naming conventions across multiple modules.
- Updated deprecated configuration warning formatting in `doxy_config.py` to use f-strings. - Adjusted regex patterns in `doxy_tag_parser.py` for better clarity. - Renamed parameters in `generatorBase.py` for consistency with naming conventions. - Enhanced error logging in `generatorBase.py` to provide clearer messages. - Updated function signatures in `generatorBase.py` to specify return types. - Refactored exception handling in `node.py` to catch specific exceptions. - Improved function definitions in `utils.py` for clarity. - Refined exception handling in `xml_parser.py` to catch specific exceptions. - Added a new ignore rule in `pyproject.toml` for assert statements in test files. - Refactored method names in `callDoxyByName.py` for consistency. - Updated function names in `parseMdTags.py` for clarity. - Refactored variable names in `snippetsTest-examples.py` for consistency. - Improved variable naming in `snippetsTest.py` for clarity. - Refactored variable names in `testTemplate.py` for consistency. - Enhanced test function signatures in `test_doxyrun.py` for clarity. - Improved test function signatures in `test_doxyrun_helpers.py` for clarity. - Updated test function signatures in `test_migration.py` for clarity.
…; improve error handling in Cache; enhance regex formatting in DoxyTagParser; update error message in GeneratorBase
…otations for improved type safety and clarity; enhance Cache class initialization.
…e Any type for values; enhance function signatures across multiple modules to support optional types and improve clarity.
… Property classes and Node class to accept None; enhance XmlParser to handle None inputs gracefully.
…line XML checks and enhance safety in attribute access; update XmlParser for cleaner parameter handling.
…a type, enhance error method signature, and refine _find_base_classes return type; improve dictionary initialization and handling of deduplicated entries.
…fety: update type hints for full_doc_files and kind_filters; enhance programlisting method parameter type for better clarity.
…update type hints, enhance handling of optional parameters, and ensure safer attribute access across multiple modules.
… return types in MkDoxyConfig classes; enhance full_doc method naming and parameter handling in GeneratorAuto; switch from sha1 to sha256 in DoxygenGenerator; improve logging format in migration; streamline XML parsing in Node; adjust parameter types in various methods for better clarity and consistency.
… hints in Cache, Doxygen, GeneratorAuto, GeneratorBase, and other modules; enhance method signatures and logging; streamline XML parsing in XmlParser; adjust import statements for consistency.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @JakubAndrysek, your pull request is too large to review
…ts: update plugin to handle ignore_errors setting and modify generator snippets to return empty string on error if ignore_errors is enabled.
- Simplified function signatures and removed unnecessary line breaks in various classes including Doxygen, DoxygenGenerator, Finder, GeneratorAuto, GeneratorBase, GeneratorSnippets, and Property. - Consolidated multi-line statements into single lines where appropriate. - Enhanced the clarity of the code by maintaining consistent formatting and style across the codebase. - Updated the handling of YAML errors and improved logging messages for better debugging. - Ensured that all changes adhere to PEP 8 style guidelines for Python code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a variety of improvements and refactoring across the codebase, focusing on type annotations, naming consistency, error handling, and code style. The most significant changes include the reimplementation and renaming of the
DoxyTagParser, enhanced type safety and error handling in the cache and configuration modules, and improvements in logging and method signatures throughout the project.