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

feat: Markdown documentation generator #963

Merged
merged 48 commits into from
Apr 1, 2024

Conversation

lars-reimann
Copy link
Member

@lars-reimann lars-reimann commented Apr 1, 2024

Closes #663

Summary of Changes

  • Add a service to generate Markdown documentation for Safe-DS files
  • Add the document CLI command to invoke this generator
  • Create Markdown documentation for the builtin stubs

Drive letters were sometimes capitalized and sometimes not, leading to incorrect computation of relative paths when using URIUtils.relative.
@lars-reimann lars-reimann linked an issue Apr 1, 2024 that may be closed by this pull request
21 tasks
@lars-reimann lars-reimann changed the title feat; generate documentation for stubs feat: Markdown documentation generator Apr 1, 2024
Copy link

github-actions bot commented Apr 1, 2024

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ CSS stylelint 1 0 0 1.42s
✅ JAVASCRIPT eslint 1 0 0 5.91s
✅ JAVASCRIPT prettier 1 0 0 0.58s
✅ JSON prettier 1 0 0 0.83s
✅ MARKDOWN markdown-link-check 62 0 1.36s
✅ REPOSITORY git_diff yes no 0.08s
✅ TYPESCRIPT eslint 19 0 0 7.21s
✅ TYPESCRIPT prettier 19 0 0 1.73s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

Copy link

codecov bot commented Apr 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (dc5bf3b) to head (a4e0320).

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.
📢 Have feedback on the report? Share it here.

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.
@lars-reimann lars-reimann marked this pull request as ready for review April 1, 2024 17:20
@lars-reimann lars-reimann merged commit 77d04de into main Apr 1, 2024
7 checks passed
@lars-reimann lars-reimann deleted the 663-generate-documentation-for-stubs branch April 1, 2024 17:20
lars-reimann pushed a commit that referenced this pull request Apr 1, 2024
## [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))
@lars-reimann
Copy link
Member Author

🎉 This PR is included in version 0.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Included in a release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate documentation for stubs
2 participants