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

Audit docs and convert all Web3 instance variables to use w3 name. #1183

Closed
pipermerriam opened this issue Jan 4, 2019 · 10 comments
Closed

Comments

@pipermerriam
Copy link
Member

What was wrong?

A while back we settled on a convention of using w3 as the variable name for an instance of the Web3 object. We still have some places in the docs that use the old web3 name.

How can it be fixed?

Check through the docs for code examples which use the variable name web3 to represent an instance of the Web3 object and convert them to use w3 instead.

@scottrepreneur
Copy link

Are there more instances that are looking to be updated @pipermerriam? @aherzfeld suggested "web3 is used as the variable for instances of web3 in many of the .py files" in the previous pull. Would that be good for consistency?

@pipermerriam
Copy link
Member Author

It'd be good to be completely consistent across both .py and documentation to only use w3.

@aherzfeld
Copy link
Contributor

I can take a crack at updating the .py files as well

@marcobesier
Copy link

Hey there, I'm looking to make my first contribution to Web3.py (and first contribution to open-source, in general). Given that the issue is still marked as Open, I was wondering whether there is still something I can help with.

@kclowes
Copy link
Collaborator

kclowes commented Dec 8, 2021

@marcobesier Welcome! Yep, there are still many places in our docs where we us web3 instead of w3. docs/web3.eth.rst is a prime example. Any code examples using web3.eth can move to w3.eth, but if you're doing a find and replace, be sure to not break the doc links (which look like: :attr:'~web3.eth.Eth.default_block').

@marcobesier
Copy link

Awesome! Will take a crack at making the update.

@marcobesier
Copy link

@kclowes A quick comment on the pull-request: for now, I just updated the docs/web3.eth.rst file to see if I understood everything correctly. Once you (or someone else) approves the pull request, I would go ahead and update additional doc files in the same manner.

Also, since this is my first real contribution to open-source, please let me know in case I should do anything differently going forward regarding the pull-request submission.

@AvinashKasukurthi
Copy link

@pipermerriam I am a beginner in open source contribution.

Can you please help me to start with.

@FrostBid
Copy link

Hello, is this issue still active? I am willing to go through the docs and change them.

@pacrob
Copy link
Contributor

pacrob commented May 16, 2022

Sorry, this should have been closed. It was handled in pr #2357

@pacrob pacrob closed this as completed May 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants