Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix description of 'core:version' and creation of short-descriptions #328

Merged
merged 1 commit into from
Dec 19, 2024

Conversation

bbc131
Copy link
Contributor

@bbc131 bbc131 commented Dec 18, 2024

Problem
The short description is generated by truncating the long description at the first period (".").
This doesn't work (for example) for the description of version in the global object, which contains the format specifier "X.Y.Z", the corresponding output is broken (ends with "X").

Fix
With the present commit, the first period followed by a space is used to truncate the short description.
Additionally, a missing period at the end of the description of version is added.

@Teque5
Copy link
Collaborator

Teque5 commented Dec 19, 2024

Thanks! Seems like a no-nonsense PR, but I don't know where the short description is used so I'll let @777arc approve & merge.

@bbc131
Copy link
Contributor Author

bbc131 commented Dec 19, 2024

Alright, the short description is used for the tables.

@777arc
Copy link
Member

777arc commented Dec 19, 2024

Nice catch, and ty for the fix!

@777arc
Copy link
Member

777arc commented Dec 19, 2024

@bbc131 btw in case you didnt know, you can preview the html and pdf if you go to the github action that runs as part of the PR check, then go to summary and there should be a download at the bottom

@777arc 777arc self-requested a review December 19, 2024 06:08
@777arc 777arc merged commit 6fed8e4 into sigmf:main Dec 19, 2024
1 check passed
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.

3 participants