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

docs: Highlighting the fact, that certain methods do not work in place #279

Conversation

PhilipGutberlet
Copy link
Contributor

Closes #189.

Summary of Changes

Highlighting the fact, that fitting methods of Classifier, Regressor, Tabletransformer and certain methods of the _table class do not work in place.

@PhilipGutberlet PhilipGutberlet requested a review from a team as a code owner May 5, 2023 14:15
@PhilipGutberlet PhilipGutberlet changed the title doc: Highlighting the fact, that certain methods do not work in place docs: Highlighting the fact, that certain methods do not work in place May 5, 2023
@lars-reimann
Copy link
Member

lars-reimann commented May 5, 2023

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ MARKDOWN markdown-link-check 1 0 58.35s
✅ PYTHON black 5 0 0 0.9s
✅ PYTHON mypy 5 0 1.94s
✅ PYTHON ruff 5 0 0 0.05s
✅ REPOSITORY git_diff yes no 0.03s

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

@codecov
Copy link

codecov bot commented May 5, 2023

Codecov Report

Merging #279 (56198c2) into main (40fb756) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #279   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           44        44           
  Lines         1708      1708           
=========================================
  Hits          1708      1708           
Impacted Files Coverage Δ
src/safeds/data/tabular/containers/_table.py 100.00% <ø> (ø)
src/safeds/data/tabular/transformation/_imputer.py 100.00% <ø> (ø)
...feds/data/tabular/transformation/_label_encoder.py 100.00% <ø> (ø)
...ds/data/tabular/transformation/_one_hot_encoder.py 100.00% <ø> (ø)
.../data/tabular/transformation/_table_transformer.py 100.00% <ø> (ø)

Copy link
Member

@lars-reimann lars-reimann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Such a hint would also be great for Column.rename and Column.transform (the latter gets added in #270).

@lars-reimann lars-reimann merged commit dcf2e6c into main May 6, 2023
@lars-reimann lars-reimann deleted the 189-always-specify-explicitly-that-methods-do-not-change-an-object-in-place-but-return-a-new-one branch May 6, 2023 08:37
@lars-reimann
Copy link
Member

🎉 This PR is included in version 0.12.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label May 11, 2023
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.

Always specify explicitly that methods do not change an object in place but return a new one
3 participants