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

chore: Simplify stable api docstrings #1278

Merged
merged 2 commits into from
Oct 29, 2024

Conversation

MarcoGorelli
Copy link
Member

@MarcoGorelli MarcoGorelli commented Oct 29, 2024

The current check for the stable api docstrings is probably not worth the effort:

  • we don't have stable.v1-specialised docstrings for everything
  • it's annoying to have to redefine every top-level function in the stable api. We should only need to do so if:
    • we need to invoke _stableify
    • there is some breaking change we wish to preserve in v1
  • simpler tests mean that the contribution process is simplified, and that's ultimately a top-priority goal

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

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

Related issues

  • Related issue #
  • Closes #

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 marked this pull request as ready for review October 29, 2024 09:20
@MarcoGorelli MarcoGorelli merged commit acfaadc into narwhals-dev:main Oct 29, 2024
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant