You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+38Lines changed: 38 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
40
40
### Documentation
41
41
42
42
-**Complete README Overhaul**: The `README.md` has been completely rewritten to be more comprehensive, professional, and user-friendly. It now includes a clear project mission, a detailed table of contents, expanded sections on features and usage, new examples, and platform compatibility information.
-**Process Individual Files**: The CLI now accepts both directory and individual file paths, allowing for more granular control over which files are processed.
50
+
-**Expanded Keywords**: Added a comprehensive list of keywords to `pyproject.toml` to significantly improve package discoverability on PyPI and search engines.
51
+
-**Beta Features Flag**: Introduced a `--beta` command-line flag to enable experimental features that are under development.
52
+
53
+
### Changed
54
+
55
+
-**Header Text Update**: Changed the auto-generated header to "Table of content is automatically generated by Agent Docstrings {version}".
56
+
-**Streamlined Header Format**: The format of the generated "Table of Contents" has been improved. Top-level functions and classes are now presented in a single, chronologically sorted list, removing the nested "Functions" section for a cleaner, more intuitive layout.
57
+
-**Deterministic Sorting**: All discovered items (classes, methods, functions) are now strictly sorted by their line number in the source file, ensuring a consistent and predictable output every time.
58
+
-**CLI Argument Renaming**: The `DIRECTORY` argument in the CLI has been renamed to `PATH` to accurately reflect its new capability to handle both files and directories.
59
+
-**Header Version Updates**: The tool will now update the header if the generator version has changed, even if the code structure remains the same, ensuring docstrings always reflect the version of the tool that generated them.
60
+
-**Repository URLs**: Updated project URLs in `pyproject.toml` to point to the correct `AgentDocstrings` repository name.
61
+
62
+
### Fixed
63
+
64
+
-**Error Handling for Inaccessible Directories**: Fixed a crash (`PermissionError`) that occurred when scanning directories with restricted read permissions. The application will now skip such directories and print a warning, preventing unintended modifications to files that might have been excluded by an unreadable `.gitignore` or other configuration files.
65
+
-**Deleting empty lines**: Detected and fixed the removal of empty lines at the end of processed files
66
+
-**Language-Specific Indentation**: Fixed the indentation in the generated 'Table of Contents' to respect common style conventions for each language (e.g., 4 spaces for Python, 2 for JavaScript).
67
+
68
+
### Build
69
+
70
+
-**Python Version Support**: Updated the minimum required Python version from 3.8 to 3.10 to align with modern dependencies and language features. Project metadata (`pyproject.toml`) and CI configurations have been updated accordingly.
71
+
72
+
### CI/CD
73
+
74
+
-**Continuous Integration Workflow**: Added a new GitHub Actions workflow (`ci.yml`) to automatically run tests on all pushes and pull requests to the `master` branch. The workflow tests against multiple Python versions (3.10-3.13) and includes matrix testing for beta features.
75
+
76
+
### Documentation
77
+
78
+
-**Complete README Overhaul**: The `README.md` has been completely rewritten to be more comprehensive, professional, and user-friendly. It now includes a clear project mission, a detailed table of contents, expanded sections on features and usage, new examples, and platform compatibility information.
79
+
-**Pull Request Template**: Added a `PULL_REQUEST_TEMPLATE.md` to standardize contributions.
80
+
-**Demo Video**: Included a new video in the `README.md` to demonstrate the tool's functionality.
0 commit comments