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

Add Python code and documentation for Python beginners #1

Open
diffrxction opened this issue Sep 30, 2022 · 7 comments · Fixed by #14 or #23
Open

Add Python code and documentation for Python beginners #1

diffrxction opened this issue Sep 30, 2022 · 7 comments · Fixed by #14 or #23
Assignees
Labels
code and documentation Issues that need both code and documentation in Markdown files. hacktoberfest Issues related to the hacktoberfest 2022 event hacktoberfest-starters Issues that can be possibly solved by beginners to open-source

Comments

@diffrxction
Copy link
Member

diffrxction commented Sep 30, 2022

You are required to add Python code and relevant documentation in sub-folders within the Python folder.
Python code and documentation should be in the same sub-folder.

Example:

├── Python
│   ├── Loops in Python (add code and documentation within the new loops in python sub-folder.
│   │   ├── loops.py (Python file showing working of loops)
|   |   ├── loops.md (Markdown file for documentation on how your code works)
│   ├── Functions in Python (code and documentation within one sub-folder)
│   ├── Importing Libraries
│   ├── Python.md (Leave this file intact)

YOU NEED TO SUBMIT BOTH CODE AND MARKDOWN FILE FOR THIS ISSUE

So, the required topics are:

  • Data Types
  • Loops
  • Functions
  • Generators (advanced)
  • importing libraries like NumPy, pandas, scikit-learn
  • Arrays/Lists in Python (declaring, iterating, and storing values)
  • NumPy arrays (basics ndarray behavior, difference from lists
    (More important contributions)
  • Implementing an inbuilt NumPy function in Python from scratch
  • Creating your own package in Python for a simple task.

If you are interested, add a comment to this issue and I will allocate the issue to you.

Please see, you will be allotted a small portion of the topics mentioned above just so all interested people have a chance to contribute.
Also notice the labels for each issue, that will give you an idea about what kind of work you are expected to do.

Cheers! 😄

@diffrxction diffrxction added hacktoberfest Issues related to the hacktoberfest 2022 event hacktoberfest-starters Issues that can be possibly solved by beginners to open-source code and documentation Issues that need both code and documentation in Markdown files. labels Sep 30, 2022
@Kunal-Garg-12
Copy link

Assign loops topic to me

@diffrxction
Copy link
Member Author

Assign loops topic to me

Okay @Kunal-Garg-12 you can write code for different loops in Python and add relevant documentation in Python to go along with your code.

Also, please do not forget to maintain the same folder structure as shown above. Create a subfolder for loops and proceed to add loops.py along with the loops.md Markdown documentation file.

@daskamalini85
Copy link

daskamalini85 commented Oct 1, 2022

PLEASE ALLOT THE SECTION OF FUNCTIONS IN PYTHON TO ME @diffrxction

@ArmaanSeth
Copy link
Contributor

@diffrxction I will be happy to contribute and have opted for "importing libraries like NumPy, pandas, scikit-learn".
Hoping to receive your confirmation as soon as possible!!!

@diffrxction
Copy link
Member Author

PLEASE ALLOT THE SECTION OF FUNCTIONS IN PYTHON TO ME @diffrxction

Okay @daskamalini85 you can proceed with writing about functions in Python, give a few examples of functions, how they work and also provide one documentation file in Markdown (.md) format.

Also, do not forget to follow the folder structure. Create your own subfolder for functions and add functions.py and .md files there.

@Javali-M
Copy link
Contributor

Javali-M commented Oct 6, 2022

@diffrxction Please assign the NumPy arrays section to me, I'll be happy to work on it.

@diffrxction
Copy link
Member Author

@diffrxction Please assign the NumPy arrays section to me, I'll be happy to work on it.

Sure, @Javali-M. Remember to create a new folder titled NumPy arrays and within this folder include both code and documentation (in .py /.ipynb and .md files). All the best!

@diffrxction diffrxction linked a pull request Oct 6, 2022 that will close this issue
@Kunal-Garg-12 Kunal-Garg-12 removed their assignment Oct 8, 2022
diffrxction pushed a commit that referenced this issue Oct 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code and documentation Issues that need both code and documentation in Markdown files. hacktoberfest Issues related to the hacktoberfest 2022 event hacktoberfest-starters Issues that can be possibly solved by beginners to open-source
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants