Skip to content

Commit 7bf4081

Browse files
committed
minor: updated CHANGELOG.md to v2.3.0
1 parent d039f78 commit 7bf4081

File tree

5 files changed

+43
-6
lines changed

5 files changed

+43
-6
lines changed

CHANGELOG.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
// ├───────────────────────────────────────────────────────────────┘
55
// │
66
// ├──┐Changelog - toc
7+
// │ ├──┐[2.3.0] - 2024-02-02
8+
// │ │ ├── Added
9+
// │ │ ├── Documentation
10+
// │ │ ├── Fixed
11+
// │ │ ├── Performance
12+
// │ │ └── Testing
713
// │ ├──┐[2.2.0] - 2024-01-29
814
// │ │ ├── Added
915
// │ │ ├── Documentation
@@ -20,6 +26,37 @@
2026

2127
# Changelog - toc
2228

29+
## [2.3.0] - 2024-02-02
30+
### Added
31+
32+
- If `-o outputFile` is specified, toc will write there even if the inputFile's toc is already up-to-date
33+
- Support for rstudio foldable sections
34+
35+
### Documentation
36+
37+
- Added useful tools to CONTRIBUTING.md
38+
- Explaining better what _prettify_connector() does
39+
40+
### Fixed
41+
42+
- Not stripping lines to preserve cobol indentation
43+
- Avoiding printing twice the same error or warning message
44+
45+
### Performance
46+
47+
- Drastic performance improvements by reducing regex replacements, loops, and list comprehensions
48+
- Simplified and explained _prettify_connectors()
49+
- Unified comment replacement in _replace_comment()
50+
- Defining toc multiline regex pattern once
51+
- Centralized file opening function
52+
- Storing toc pieces in lists until _generate_toc()
53+
54+
### Testing
55+
56+
- Added complex toc nexting
57+
- Added more unit tests to toc.py
58+
- Added check for missing reference file
59+
2360
## [2.2.0] - 2024-01-29
2461
### Added
2562

@@ -42,7 +79,7 @@
4279
- Limiting re.sub to 1 also if toc needs to be added
4380
- Avoid re.sub if first line is empty
4481
- Sanitizing input file type to str
45-
- Fixed a bug that may lead to multiple tocs being added
82+
- Fixed a bug thay may lead to multiple tocs being added
4683

4784
### Testing
4885

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ build-backend = "setuptools.build_meta"
1919

2020
[project]
2121
name = "tableofcontents"
22-
version = "2.2.0"
22+
version = "2.3.0"
2323
authors = [
2424
{ name="AlphaJack" },
2525
]
@@ -65,7 +65,7 @@ ignore_tags = "rc"
6565
sort_commits = "newest"
6666
commit_parsers = [
6767
{ message = "^(feat|[Aa]dd)", group = "Added" },
68-
{ message = "^[Aa]dd", group = "Added" },
68+
{ message = "^perf", group = "Performance" },
6969
{ message = "^change", group = "Changed" },
7070
{ message = "^[Dd]oc", group = "Documentation" },
7171
{ message = "^deprecat", group = "Deprecated" },

tests/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/usr/bin/env python
22

3-
__version__ = "2.2.0"
3+
__version__ = "2.3.0"

toc/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/usr/bin/env python
22

3-
__version__ = "2.2.0"
3+
__version__ = "2.3.0"

toc/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
# accept arguments
2121
import argparse
22-
__version__ = "2.2.0"
22+
__version__ = "2.3.0"
2323

2424
# heredoc in help epilog
2525
from argparse import RawDescriptionHelpFormatter

0 commit comments

Comments
 (0)