docs: add docstring guidelines to CONTRIBUTING.md#1957
Merged
MarcoGorelli merged 2 commits intomainfrom Feb 8, 2025
Merged
Conversation
MarcoGorelli
approved these changes
Feb 8, 2025
CONTRIBUTING.md
Outdated
| Writing the docstring in Narwhals is not an exact science, but we have some high level guidelines (if in doubt just ask us in the PR): | ||
|
|
||
| - The examples should be clear and to the point. | ||
| - The examples should import _one_ dataframe library, create a datafrane and exemplify the Narwhals functionality. |
MarcoGorelli
reviewed
Feb 8, 2025
MarcoGorelli
deleted the
docs/add-docstring-guidelines-to-contributing
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
Related issues
Checklist
If you have comments or can explain your changes, please do so below
All other changes are unrelated via
markdownlint