Skip to content

Commit ce954c7

Browse files
committed
docs: update release notes
1 parent 6e91423 commit ce954c7

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

docs/strictdoc_04_release_notes.sdoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,20 +52,22 @@ TITLE: Unreleased
5252
[TEXT]
5353
MID: 12345f3b28ea4bfe9ca8afe6b21826a8
5454
STATEMENT: >>>
55-
This release includes an enhancement to the Diff/Changelog feature, the removal of legacy @sdoc markers, several bug fixes, and improvements for edge cases.
55+
This release includes several enhancements, the removal of legacy @sdoc markers, several bug fixes, and improvements for edge cases.
5656

5757
The Diff/Changelog feature has been extended to support the new --generate-diff-git option which allows generating the Diff/Changelog screens for a given pair of Git revisions.
5858

5959
The legacy ``@sdoc`` marker has been removed from the codebase. From now on, only the ``@relation`` markers are recognized when linking requirements with source code files.
6060

61-
An edge case has been fixed where StrictDocs FileFinder was detecting Linux pipe files that could not be processed meaningfully by StrictDoc’s source file generator. With this release, such files are now ignored.
61+
An edge case has been fixed where StrictDoc's FileFinder was detecting Linux pipe files that could not be processed meaningfully by StrictDoc’s source file generator. With this release, such files are now ignored.
6262

6363
The Diff/Changelog feature has been extended to better support change tracking of included documents. Previously, only the contents of included documents were visualized, but not the root nodes of the documents themselves. Now, changes to included documents, such as their UID or TITLE, are displayed correctly.
6464

6565
The ReqIF-to-SDoc converter has been improved to handle integer fields by treating them as string grammar fields. Since StrictDoc does not yet support INTEGER fields, they are converted to STRING fields during import. This workaround was sufficient to support the user’s use case.
6666
Thanks to @kerfallaCisse for reporting this issue.
6767

6868
The HTML2PDF generator has been fixed to correctly resolve document paths when printing a bundle document that includes other documents. This edge case involved a combination of three features — HTML2PDF, bundle documents, and composable documents — that had not previously been tested to work together. Thanks to @CMon for reporting this issue.
69+
70+
The source code node parser has been updated to recognize only field names that are defined in the corresponding document grammar. This prevents the parser from incorrectly interpreting unrelated ``FIELD: VALUE`` strings found in source code. Thanks to @haxtibal for contributing this improvement.
6971
<<<
7072

7173
[[/SECTION]]

strictdoc/backend/sdoc_source_code/caching_reader.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,7 @@ def _get_reader(
8383
or path_to_file.endswith(".cpp")
8484
):
8585
custom_tags = (
86-
[
87-
field.title
88-
for field in source_node_grammar_element.fields
89-
]
86+
source_node_grammar_element.get_field_titles()
9087
if source_node_grammar_element is not None
9188
else None
9289
)

0 commit comments

Comments
 (0)