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

DOC: Fix error in output of method #1064

Closed
3 tasks done
ShreeluSantosh opened this issue May 26, 2024 · 3 comments · Fixed by #1071
Closed
3 tasks done

DOC: Fix error in output of method #1064

ShreeluSantosh opened this issue May 26, 2024 · 3 comments · Fixed by #1071
Assignees
Labels
gssoc GSSoC 2024

Comments

@ShreeluSantosh
Copy link

What's wrong with the existing documentation

In the documentation.md, the following code snippet gives an error (given in screenshots)

# Import the required module
from scrape_up import github

# Instantiate an object with the username provided.
user = github.Users(username="nikhil25803")

# Call the followers function - it will return the number of followers
per user.followers()

The reason is that per keyword doesn't exist in Python.

So, I've corrected it to use print function instead.

# Import the required module
from scrape_up import github

# Instantiate an object with the username provided.
user = github.Users(username="nikhil25803")

# Call the followers function - it will return the number of followers
print(user.followers())

Add ScreenShots

The output for the code snippet in the documentation.md
Screenshot 2024-05-26 222706

Output after replacing per with print function
Screenshot 2024-05-26 222725

Record

  • I agree to follow this project's Code of Conduct
  • I'm a GSSoC'24 contributor
  • I want to work on this issue
Copy link

Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.

@nikhil25803
Copy link
Member

Go ahead @ShreeluSantosh

@ShreeluSantosh
Copy link
Author

Pull request: #1071

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc GSSoC 2024
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants