feat: support for examples in documentation comments #1045
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports MegaLinter is graciously provided by |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1045 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 99 99
Lines 19051 19148 +97
Branches 3902 3920 +18
=========================================
+ Hits 19051 19148 +97 ☔ View full report in Codecov by Sentry. |
lars-reimann
pushed a commit
that referenced
this pull request
Apr 18, 2024
## [0.12.0](v0.11.0...v0.12.0) (2024-04-18) ### Features * better error if `+` is used for string concatenation ([#1044](#1044)) ([8be49c5](8be49c5)) * collapse class/literal types in inlay hints ([#1053](#1053)) ([7db2820](7db2820)), closes [#1048](#1048) * **deps:** require latest runner (`v0.11.0`) ([#1058](#1058)) ([7ae1f6b](7ae1f6b)) * don't stop validation at syntax errors ([#1049](#1049)) ([db0c5d7](db0c5d7)) * error if name of static member equals name of inherited member ([#1054](#1054)) ([b8e17af](b8e17af)) * hide classes that are only for typing from auto-completion ([#1056](#1056)) ([50851d7](50851d7)), closes [#1026](#1026) * ignore parameter names for default values and yields ([#1059](#1059)) ([dde4de0](dde4de0)) * ignore parameter names when type checking arguments ([#1052](#1052)) ([a1e6717](a1e6717)), closes [#1046](#1046) * installer for the runner ([#1038](#1038)) ([2bde594](2bde594)) * map literals are no longer experimental ([#1039](#1039)) ([1d9af4b](1d9af4b)) * separate VS Code languages for pipeline/stub/tests ([#1043](#1043)) ([8147480](8147480)) * support for examples in documentation comments ([#1045](#1045)) ([3da6d6f](3da6d6f)), closes [#1027](#1027) * updater for the runner ([#1042](#1042)) ([610d45b](610d45b)) ### Bug Fixes * don't sync `safe-ds.runner.command` setting ([bb57481](bb57481)) * save all files before opening the EDA tool ([d6d0c22](d6d0c22)) * start runner if configuration did not change after installation ([#1040](#1040)) ([b4f015a](b4f015a)) * substitute type parameters for lambda parameters ([#1050](#1050)) ([46145dd](46145dd)), closes [#1047](#1047)
|
🎉 This PR is included in version 0.12.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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes partially #1027
Summary of Changes
Documentation comments can now contain an
@exampletag. Any text in the following Markdown paragraph is treated as Safe-DS code. It is shown in tooltips and included in the generated API documentation.There are tests to ensure the correctness of examples in the builtin stubs.