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.

Sign up for GitHub

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

Jump to bottom

Lines of examples can also start with ... instead of >>> #129

Closed
lars-reimann opened this issue May 4, 2024 · 1 comment · Fixed by #130
Closed

Lines of examples can also start with ... instead of >>> #129

lars-reimann opened this issue May 4, 2024 · 1 comment · Fixed by #130
Assignees
@lars-reimann
Labels
enhancement 💡 New feature or request released Included in a release

Comments

@lars-reimann
Copy link
Member

Is your feature request related to a problem?

I've overlooked that lines containing example code can also start with ... instead of >>>. Example from TabularDataset:

Examples
--------
>>> from safeds.data.labeled.containers import TabularDataset
>>> dataset = TabularDataset(
...     {"id": [1, 2, 3], "feature": [4, 5, 6], "target": [1, 2, 3]},
...     target_name="target",
...     extra_names=["id"]
... )

Desired solution

Treat lines starting with ... the same as lines starting with >>> when creating examples in the stubs.

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

No response
@lars-reimann lars-reimann added the enhancement 💡 New feature or request label May 4, 2024
@lars-reimann lars-reimann self-assigned this May 4, 2024
@lars-reimann lars-reimann moved this from Backlog to In Progress in Library Analysis May 4, 2024
@lars-reimann lars-reimann mentioned this issue May 4, 2024
Merged
@lars-reimann lars-reimann linked a pull request May 4, 2024 that will close this issue
fix: Include lines of examples that start with ... #130
Merged
Masara pushed a commit that referenced this issue May 4, 2024
@lars-reimann
fix: Include lines of examples that start with ... (#130)
3477b4a 
Closes #129

### Summary of Changes

Lines of examples that start with `...` are now included in the
generated stubs.
@github-project-automation github-project-automation bot moved this from In Progress to ✔️ Done in Library Analysis May 4, 2024
lars-reimann pushed a commit that referenced this issue May 4, 2024
@semantic-release-bot
chore(release): 0.3.0 [skip ci]
823b0f0 
## [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)
@lars-reimann
Copy link
Member Author

🎉 This issue has been resolved in version 0.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label May 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lars-reimann lars-reimann

Labels
enhancement 💡 New feature or request released Included in a release
Projects
Library Analysis
Status: ✔️ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: Include lines of examples that start with ... Safe-DS/Stub-Generator
1 participant
@lars-reimann