feat: DocString result names for Safe-DS stub results #101
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
…e and ReST do not support multiple results.
🦙 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 #101 +/- ##
==========================================
+ Coverage 99.27% 99.28% +0.01%
==========================================
Files 22 22
Lines 2192 2250 +58
==========================================
+ Hits 2176 2234 +58
Misses 16 16 ☔ View full report in Codecov by Sentry. |
…nferred and did not have results named from docstrings
…ed results, where they would not get properly inferred and did not have results named from docstrings
…gs-for-result-names-in-generated-stubs' into 100-use-result-names-in-docstrings-for-result-names-in-generated-stubs # Conflicts: # src/safeds_stubgen/api_analyzer/_ast_visitor.py # tests/safeds_stubgen/stubs_generator/__snapshots__/test_generate_stubs/test_stub_docstring_creation[numpydoc-NUMPYDOC].sdsstub
Masara
force-pushed
the
100-use-result-names-in-docstrings-for-result-names-in-generated-stubs
branch
from
79fd2a6 to
e124b35
Compare
…t-names-in-generated-stubs
…t-names-in-generated-stubs
lars-reimann
requested changes
Apr 9, 2024
…t-names-in-generated-stubs # Conflicts: # tests/safeds_stubgen/stubs_generator/__snapshots__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[infer_types_module].sdsstub # tests/safeds_stubgen/stubs_generator/__snapshots__/test_generate_stubs/test_stub_docstring_creation[numpydoc-NUMPYDOC].sdsstub
…gs-for-result-names-in-generated-stubs' into 100-use-result-names-in-docstrings-for-result-names-in-generated-stubs
…t-names-in-generated-stubs
|
@lars-reimann The linter failed to run |
|
Nevermind, it runs now |
|
@lars-reimann Could you merge this with higher priority? This is required for issue #80 |
Masara
force-pushed
the
100-use-result-names-in-docstrings-for-result-names-in-generated-stubs
branch
from
4d2bf27 to
134532f
Compare
lars-reimann
approved these changes
Apr 11, 2024
lars-reimann
deleted the
100-use-result-names-in-docstrings-for-result-names-in-generated-stubs
branch
lars-reimann
pushed a commit
that referenced
this pull request
May 4, 2024
## [0.3.0](v0.2.0...v0.3.0) (2024-05-04) ### Features * Added handling for sequence classes ([#127](#127)) ([cb061ab](cb061ab)), closes [#126](#126) * DocString result names for Safe-DS stub results ([#101](#101)) ([fe163e3](fe163e3)), closes [#100](#100) * Examples from docstrings are also taken over to stub docstrings ([#116](#116)) ([6665186](6665186)), closes [#115](#115) * Replace the docstring_parser library with Griffe ([#79](#79)) ([9b2f802](9b2f802)) ### Bug Fixes * `Self` types as results are translated to class names ([#110](#110)) ([4554a56](4554a56)), closes [#86](#86) * Creating stubs with relative paths for source and output directories ([#128](#128)) ([b4493c9](b4493c9)), closes [#125](#125) * Docstrings have the correct indentation for nested classes (stubs) ([#114](#114)) ([c7b8550](c7b8550)), closes [#113](#113) * Fixed a bug where double ? would be generated for stubs ([#103](#103)) ([c35c6ac](c35c6ac)), closes [#87](#87) [#87](#87) * Fixed a bug where imports would not check reexports for shortest path ([#112](#112)) ([48c5367](48c5367)), closes [#82](#82) * Fixed a bug where results in stubs would not be named ([#131](#131)) ([4408c84](4408c84)), closes [#100](#100) * Fixed a bug which prevented mypy version update ([#107](#107)) ([501d2cd](501d2cd)) * Fixed the stubs generator ([#108](#108)) ([9ad6df6](9ad6df6)), closes [#80](#80) * Generated names of callback results start with result, not with param ([#104](#104)) ([6e696e9](6e696e9)), closes [#85](#85) * Include lines of examples that start with `...` ([#130](#130)) ([3477b4a](3477b4a)), closes [#129](#129) * No "// TODO ..." if return type is explicitly `None` ([#111](#111)) ([08e345f](08e345f)), closes [#83](#83) * Removed the Epydoc parser ([#89](#89)) ([684a101](684a101)) * Replaced tabs with 4 spaces ([#105](#105)) ([8e7aa5d](8e7aa5d)), closes [#84](#84) * The file structure of stubs resembles the "package" path. ([#106](#106)) ([ff1800e](ff1800e)), closes [#81](#81) * Translation of callable ([#102](#102)) ([c581e6a](c581e6a)), closes [#88](#88) [#88](#88)
|
🎉 This PR is included in version 0.3.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 #100
Summary of Changes
Result names for stubs from Numpy docstring are now supported. Google and ReST don't support multiple results or named results, therefore they handle these a bit different: