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: add missing Series str methods in api reference #1143

Conversation

AlessandroMiola
Copy link
Contributor

What type of PR is this? (check all applicable)

  • πŸ’Ύ Refactor
  • ✨ Feature
  • πŸ› Bug Fix
  • πŸ”§ Optimization
  • πŸ“ Documentation
  • βœ… Test
  • 🐳 Other

Related issues

Checklist

  • Code follows style guide (ruff)
  • Tests added
  • Documented the changes

If you have comments or can explain your changes, please do so below.

Extends utils/check_api_reference.py to Series.str methods.

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

nice one, thanks @AlessandroMiola ! doing this for other namespaces would be very welcome if you fancy it! (and for Expr.str)

@MarcoGorelli MarcoGorelli changed the title Series str methods in api reference docs: add missing Series str methods in api reference Oct 6, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 6, 2024
@AlessandroMiola
Copy link
Contributor Author

AlessandroMiola commented Oct 6, 2024

nice one, thanks @AlessandroMiola ! doing this for other namespaces would be very welcome if you fancy it! (and for Expr.str)

Sure! I was about to ask if I could have proceeded with the other namespaces as well! :)

@MarcoGorelli MarcoGorelli merged commit f9a5c60 into narwhals-dev:main Oct 6, 2024
25 checks passed
@AlessandroMiola AlessandroMiola deleted the series-str-methods-in-api-reference branch October 6, 2024 18:03
akmalsoliev pushed a commit to akmalsoliev/narwhals that referenced this pull request Oct 15, 2024
)

* docs: add to_lowercase and to_uppercase to Series.str docs

* chore: add Series.str methods to check on api-reference docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ci: check that Series.str methods all appear in the api reference
2 participants