Skip to content

Update version to 1.3.1 and enhance docstring handling#7

Merged
Artemonim merged 3 commits intodevfrom
docstring-dup-fix
Jul 1, 2025
Merged

Update version to 1.3.1 and enhance docstring handling#7
Artemonim merged 3 commits intodevfrom
docstring-dup-fix

Conversation

@Artemonim
Copy link
Owner

@Artemonim Artemonim commented Jul 1, 2025

Type of Change

  • 🐛 Bug Fix: A change that fixes an issue.
  • New Feature: A change that adds new functionality.
  • ♻️ Refactor: A code change that neither fixes a bug nor adds a feature.
  • 📚 Documentation: Changes to the documentation only.
  • ⚙️ CI/CD: Changes to our CI/CD configuration and scripts.
  • 🔨 Build: Changes that affect the build system or external dependencies.
  • 🎨 Style: Changes that do not affect the meaning of the code (white-space, formatting, etc.).
  • Revert: Reverts a previous commit.

Description

Added

  • Python Single-Line Docstrings: Implemented support for identifying and merging the generated table of contents with existing single-line Python docstrings ("""docstring""").

Fixed

  • Python Docstring Generation: Fixed a critical bug where repeatedly processing a Python file with a manual docstring would cause content duplication. The logic has been reworked to ensure correct placement of the generated table of contents relative to from __future__ import statements and existing docstrings.

CI/CD

  • CI dev: The CI pipeline now runs on the dev branch, with Codecov reports limited to master.
  • Version check: Added a new check to prevent accidental version bumps in feature branches.

Checklist

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • New unit tests have been added to cover the changes.
  • Manual testing has been performed

### Changed
- Improved handling of manual docstrings in Python files to ensure correct placement and prevent duplication.
- Added a new test to verify the idempotency of processing files with existing manual docstrings.
- Updated `.gitignore` to include `temporary/` and `git_diff.txt`.

### Fixed
- Resolved issues with the generation of Python docstrings to ensure they do not duplicate content on subsequent runs.
@Artemonim Artemonim marked this pull request as ready for review July 1, 2025 07:51
@Artemonim Artemonim merged commit a12cd55 into dev Jul 1, 2025
@Artemonim Artemonim deleted the docstring-dup-fix branch July 1, 2025 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant