Symbol types in headings and table of contents #1164
Assignees
Labels
documentation 📖
Improvements or additions to documentation
enhancement 💡
New feature or request
released
Included in a release
Comments
lars-reimann
added
enhancement 💡
lars-reimann
added a commit
that referenced
this issue
May 18, 2024
Closes #1164 ### Summary of Changes Show symbol types in headings and table of contents of the API reference. --------- Co-authored-by: megalinter-bot <129584137+megalinter-bot@users.noreply.github.com>
lars-reimann
pushed a commit
that referenced
this issue
May 29, 2024
## [0.17.0](v0.16.1...v0.17.0) (2024-05-29) ### Features * hide columns in EDA ([#1181](#1181)) ([15ccaac](15ccaac)), closes [#1171](#1171) * infer column type using runner ([#1182](#1182)) ([846f404](846f404)), closes [#994](#994) * integrate version 0.26.0 of the `safe-ds` Python library ([#1184](#1184)) ([e79de17](e79de17)) * show symbol types in headings and table of contents ([#1178](#1178)) ([b2f0966](b2f0966)), closes [#1164](#1164) * sort rows in EDA ([#1183](#1183)) ([ddd5186](ddd5186)), closes [#1151](#1151)
|
🎉 This issue has been resolved in version 0.17.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem?
We should show symbol types in headings and table of contents, so it's easy to identify whether something is a class/function/attribute/whatever.
Desired solution
Format it identically to our library documentation:
Heading:
TOC:
We already show keywords for symbol headings, but it's more visible if the background color of the tags also changes. No symbol types are shown in the TOC at all.
Use
funinstead ofmethetc. We should still use the Safe-DS keywords.We should also wrap the names of declarations in headings into an inline code element.
Possible alternatives (optional)
No response
Screenshots (optional)
No response
Additional Context (optional)
No response
The text was updated successfully, but these errors were encountered: