-
Notifications
You must be signed in to change notification settings - Fork 0
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
feat: Markdown documentation generator #963
Conversation
Drive letters were sometimes capitalized and sometimes not, leading to incorrect computation of relative paths when using URIUtils.relative.
This indicates, which types are clickable. Furthermore, autoref and the syntax highlighting did not work well together: `Any?` as displayed as `Any` `?` and only the `Any` was linked. The same happened with `List<Int>`, which was shown as `List` `<Int>`.
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #963 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 93 94 +1
Lines 17175 17955 +780
Branches 3565 3740 +175
==========================================
+ Hits 17175 17955 +780 ☔ View full report in Codecov by Sentry. |
1. Instance members: a) Attributes b) Functions 2. Static members: a) Attributes b) Functions c) Classes d) Enums In each group, members are sorted alphabetically.
## [0.9.0](v0.8.0...v0.9.0) (2024-04-01) ### Features * `unknown` default value of stub parameters ([#952](#952)) ([78103e3](78103e3)), closes [#951](#951) * `unknown` type ([#973](#973)) ([4638249](4638249)), closes [#967](#967) * add constraints to stubs ([#953](#953)) ([dc5bf3b](dc5bf3b)) * allow any widening/narrowing type cast ([#948](#948)) ([ce01628](ce01628)) * checking of parameter bounds ([#925](#925)) ([610604f](610604f)), closes [#18](#18) * Markdown documentation generator ([#963](#963)) ([77d04de](77d04de)), closes [#663](#663) * stubs for `safe-ds` library ([#950](#950)) ([155b1c0](155b1c0)), closes [#926](#926) * VS Code command to dump diagnostics into a JSON file ([#928](#928)) ([34fa884](34fa884)), closes [#927](#927) ### Bug Fixes * do not memoize calls containing lambdas calling segments ([#944](#944)) ([114fee6](114fee6)) * language server crash on startup ([#947](#947)) ([9923074](9923074)), closes [#945](#945) * type checking of two union types ([#949](#949)) ([21fc485](21fc485))
🎉 This PR is included in version 0.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Closes #663
Summary of Changes
document
CLI command to invoke this generator