docs icon indicating copy to clipboard operation
docs copied to clipboard

[Concept Entry] Sklearn nearest-neighbours

Open codecademy-docs opened this issue 1 year ago โ€ข 11 comments

Reason/inspiration (optional)

We would like a new entry on the Nearest Neighbours concept under Sklearn. The entry should go in a new file under docs/content/sklearn/concepts/nearest-neighbours/nearest-neighbours.md.

The entry should include:

  • An introduction to the concept
  • A Syntax section that provides the syntax for the concept (if applicable)
  • An Example section that provides an example demonstrating the concept in use (if applicable)
  • A Codebyte Example section that provides a codebyte example demonstrating the concept in use (if applicable)

Please refer to the concept entry template, content standards, and markdown style guide when working on the PR for this issue.

Entry Type (select all that apply)

New Concept Entrty for Existing Topic

Code of Conduct

  • [X] By submitting this issue, I agree to follow Codecademy Doc's Code of Conduct.

For Maintainers

  • [X] Labels added
  • [ ] Issue is assigned

codecademy-docs avatar Jul 08 '24 21:07 codecademy-docs

Hey @codecademy-docs! Can I take up this issue?

igarousi avatar Jul 11 '24 21:07 igarousi

I came across the issue requesting a new entry on the Nearest Neighbours concept under sklearn. I would like to contribute to this by writing the documentation entry. Below is a brief outline of how I plan to structure the entry:

Proposed Structure

Introduction to the Concept:

  • A brief explanation of what Nearest Neighbours is and its importance.

Syntax Section:

  • Detailed syntax for using Nearest Neighbours in sklearn.

Example Section:

  • A practical example demonstrating how to use Nearest Neighbours.

Codebyte Example Section:

  • A concise code example that can be embedded in the documentation.

I will ensure to follow the concept entry template, content standards, and markdown style guide as specified.

Could you please assign this issue to me?

NeuralNoble avatar Jul 11 '24 22:07 NeuralNoble

Hey @igarousi You're assigned!๐ŸŽ‰ You can look through the Contribution Guide to know more about contributing to Codecademy Docs. Check out the Content Standards and Style Guide, theyโ€™ll help you with creating your entry.

I see this is your first time contributing to Codecademy Docs. How did you find out about us?

mamtawardhani avatar Jul 12 '24 08:07 mamtawardhani

@NeuralNoble another issue has been assigned to you ๐Ÿ˜ƒ

mamtawardhani avatar Jul 12 '24 09:07 mamtawardhani

can i be assigned this please as i have worked with Sklearn nearest-neighbours throughout projects? you can unassign that issue to me . please

NeuralNoble avatar Jul 12 '24 09:07 NeuralNoble

can i be assigned this please as i have worked with Sklearn nearest-neighbours throughout projects? you can unassign that issue to me . please

I'm really sorry @NeuralNoble, since the issue assignment is based on the first come first serve basis. However, I suppose there are a few more sklearn issues open, you can check and let me know ๐Ÿ˜ƒ

mamtawardhani avatar Jul 12 '24 09:07 mamtawardhani

@mamtawardhani Great, thank you! I learned about this contributing opportunity through Codecademy courses.

igarousi avatar Jul 12 '24 20:07 igarousi

@mamtawardhani, just posting an update: I'm still working on this issue. I will push the changes by July 20.

igarousi avatar Jul 18 '24 21:07 igarousi

can i be assigned this please as i have worked with Sklearn nearest-neighbours throughout projects? you can unassign that issue to me . please

Hey @NeuralNoble are you still interested in taking up this issue?

mamtawardhani avatar Aug 20 '24 11:08 mamtawardhani

yes

NeuralNoble avatar Aug 20 '24 21:08 NeuralNoble

yes

Hey @NeuralNoble Youโ€™re assigned ๐ŸŽ‰ In addition to the documents linked in the description, please also look at the Contribution Guide. After creating a PR, the maintainer(s) (with the collaborator label) will add comments/suggestions to address any revisions before approval.

Is this your first contribution to Codecademy Docs? If so, weโ€™re curious to know how you found out about contributing to Docs.

mamtawardhani avatar Aug 21 '24 06:08 mamtawardhani

Unassigning author due to inactivity

mamtawardhani avatar Nov 18 '24 14:11 mamtawardhani

๐ŸŒธ Thanks for closing this Issue! Please head over to the Docs Forum if you have any questions about Docs, or reply to the thread on Possible Content Discussion to share ideas and collaborate with other contributors, maintainers, or super users to determine good future issues that will help expand Docs!

github-actions[bot] avatar Nov 28 '24 07:11 github-actions[bot]