Skip to content

Commit bef6a7f

Browse files
authored
master: Release v1.3.5
2 parents 847f703 + 131ce6d commit bef6a7f

11 files changed

Lines changed: 815 additions & 681 deletions

File tree

.github/workflows/ci.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@ jobs:
107107

108108
check-version:
109109
# * Only on PRs into dev: prevent accidental version bumps.
110-
if: github.event_name == 'pull_request' && github.base_ref == 'dev'
110+
# This check is skipped for the automated post-release merge from master back to dev.
111+
if: github.event_name == 'pull_request' && github.base_ref == 'dev' && github.head_ref != 'master'
111112
name: Check for accidental version bump
112113
runs-on: ubuntu-latest
113114
steps:

CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2020

2121
- **subtitle**: describtion
2222

23+
## [1.3.5]
24+
25+
### Added
26+
27+
- **Placeholder-Based Line Numbering**: Implemented a new placeholder system (`OFFSET_PLACEHOLDER`) for calculating line numbers in generated headers. This ensures deterministic line numbering by first generating headers with placeholders, then calculating the actual offset based on the final header size, and finally replacing placeholders with accurate line numbers.
28+
29+
### Fixed
30+
31+
- **Deterministic Line Numbering**: Completely reworked the line number calculation algorithm to ensure consistent and accurate line numbers across multiple runs. The new approach uses a two-pass system that measures rather than guesses header sizes, ensuring deterministic results.
32+
- **Docstring Merging Logic**: Improved the logic for merging manual docstrings with auto-generated content. Manual content is now properly preserved and formatted without adding unnecessary newlines or reformatting.
33+
- **Multi-Pass Docstring Removal**: Enhanced the `remove_agent_docstring` function to handle complex scenarios where multiple agent-generated docstrings might be present, preventing duplication issues on repeated runs.
34+
- **Whitespace Normalization**: Added proper whitespace handling in content comparison to prevent unnecessary file modifications when only minor whitespace differences exist.
35+
- **Manual Content Extraction**: Improved the extraction of manual docstring content by properly handling the inner content within triple quotes, preserving original formatting and indentation.
36+
37+
### Testing
38+
39+
- **New Test Cases**: Added comprehensive test cases for placeholder usage, short manual docstring handling, and merged multiline docstring preservation to ensure the new algorithms work correctly across various scenarios.
40+
2341
## [1.3.4]
2442

2543
### Fixed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ The release process is partially automated.
9595
2. Update the version using `bump-my-version`:
9696
```bash
9797
# For a patch, minor, or major release
98-
bump-my-version patch/minor/major
98+
bump-my-version bump patch/minor/major
9999
```
100100
This command will update the version in `pyproject.toml` and update the `CHANGELOG.md`, replacing `[NextRelease]` with the new version tag.
101101
3. Commit the version bump: `git commit -am "chore: release v.x.y.z"`

agent_docstrings/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
Attributes:
88
__version__ (str): Current version of the *agent-docstrings* package.
99
"""
10-
__version__ = "1.3.4"
10+
__version__ = "1.3.5"

0 commit comments

Comments
 (0)