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: shorten docstring examples in narwhals/expr.py #1915

Merged

Conversation

MarcoGorelli
Copy link
Member

@MarcoGorelli MarcoGorelli commented Feb 2, 2025

Copilot helped me to shorten the docstrings

I then went through and fixup out the outputs, and sometimes fixed up the examples too

Aside from reducing size, I think like this they're more to-the-point

We could then have some follow-up PRs to diversity the examples a bit to showcase different libraries

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

  • 💾 Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • 🔧 Optimization
  • 📝 Documentation
  • ✅ Test
  • 🐳 Other

Related issues

  • Related issue #<issue number>
  • Closes #<issue number>

Checklist

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

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

@MarcoGorelli MarcoGorelli changed the title Auto generated docstrings docs: shorten docstring examples in narwhals/expr.py Feb 2, 2025
@MarcoGorelli MarcoGorelli added the documentation Improvements or additions to documentation label Feb 2, 2025
@MarcoGorelli MarcoGorelli marked this pull request as ready for review February 2, 2025 16:17
@MarcoGorelli
Copy link
Member Author

gonna ship this then, as we'd discussed this in Friday's call (https://hackmd.io/HJdFvJhjQl2iXMUDpVf_9Q) and people were on board

@MarcoGorelli MarcoGorelli merged commit 22d6df3 into narwhals-dev:main Feb 2, 2025
23 checks passed
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.

1 participant