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

Update syntax for second parameter in split() method #3441

Merged
merged 6 commits into from Oct 6, 2023

Conversation

christina-ml
Copy link
Contributor

Description

Closes #3402

This edit is for the Python Strings: Split method located under the file path docs/content/python/concepts/strings/terms/split/split.md

Edit the syntax section to clarify that the second parameter in the split() method is the maximum number of splits. Also include the default when a number isn't given.

My changes:

  • Edit syntax section to clarify that the second parameter in the split() method is the maximum number of splits
  • Rename second parameter from number_of_items to maxsplit for clarification as to what this parameter does. It is not a count for the number of items, instead it sets a maximum number of times the string can be split.
  • Explain what the default value is if second parameter is not specified, or if the second parameter has a value of -1

Type of Change

  • Editing an existing entry (fixing a typo, bug, issues, etc)
  • Updating the documentation

Checklist

  • All writings are my own.
  • My entry follows the Codecademy Docs style guide.
  • My changes generate no new warnings.
  • I have performed a self-review of my own writing and code.
  • I have checked my entry and corrected any misspellings.
  • I have made corresponding changes to the documentation if needed.
  • I have confirmed my changes are not being pushed from my forked main branch.
  • I have confirmed that I'm pushing from a new branch named after the changes I'm making.
  • Under "Development" on the right, I have linked any issues that are relevant to this PR (write "Closes # in the "Description" above).

@CLAassistant
Copy link

CLAassistant commented Oct 4, 2023

CLA assistant check
All committers have signed the CLA.

@caupolicandiaz caupolicandiaz self-assigned this Oct 4, 2023
@caupolicandiaz caupolicandiaz added enhancement New feature or request python Python entries hacktoberfest status: under review Issue or PR is currently being reviewed labels Oct 4, 2023
Copy link
Collaborator

@caupolicandiaz caupolicandiaz left a comment

Choose a reason for hiding this comment

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

@christina-ml Just a couple of edits. Please update the entry, and tag me when you've finished the changes. Thanks

content/python/concepts/strings/terms/split/split.md Outdated Show resolved Hide resolved
content/python/concepts/strings/terms/split/split.md Outdated Show resolved Hide resolved
christina-ml and others added 3 commits October 4, 2023 17:03
Co-authored-by: caupolicandiaz <caupolicandiaz@gmail.com>
Co-authored-by: caupolicandiaz <caupolicandiaz@gmail.com>
@christina-ml
Copy link
Contributor Author

@caupolicandiaz I updated the entry with the suggested changes.

Copy link
Collaborator

@caupolicandiaz caupolicandiaz left a comment

Choose a reason for hiding this comment

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

@christina-ml This is ready for a second review.

Copy link
Collaborator

@SSwiniarski SSwiniarski left a comment

Choose a reason for hiding this comment

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

@christina-ml, @caupolicandiaz looks good to me.

@SSwiniarski SSwiniarski added status: review 2️⃣ completed hacktoberfest-accepted Indicates the PR was approved, merged, and pertains to Hacktoberfest and removed status: ready for next review labels Oct 6, 2023
@SSwiniarski SSwiniarski self-assigned this Oct 6, 2023
@SSwiniarski SSwiniarski merged commit 7dbba40 into Codecademy:main Oct 6, 2023
6 checks passed
@github-actions
Copy link

github-actions bot commented Oct 6, 2023

👋 @christina-ml
You have contributed to Codecademy Docs, and we would like to know more about you and your experience.
Please take a minute to fill out this four question survey to help us better understand Docs contributions and how we can improve the experience for you and our learners.
Thank you for your help!

🎉 Your contribution(s) can be seen here:

https://www.codecademy.com/resources/docs/python/strings/split

Please note it may take a little while for changes to become visible.
If you're appearing as anonymous and want to be credited, see here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest hacktoberfest-accepted Indicates the PR was approved, merged, and pertains to Hacktoberfest python Python entries status: review 1️⃣ completed status: review 2️⃣ completed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Edit] Python [Edit] Python Strings: Split
4 participants