Skip to content

Replace public addresses with account variables #2594

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

Merged
merged 5 commits into from
Jul 5, 2023
Merged

Conversation

B3nac
Copy link
Contributor

@B3nac B3nac commented Aug 5, 2022

What was wrong?

The public addresses used in the documentation were in use by real home grown organic human beings.

Related to Issue #2011

How was it fixed?

Heroically switched all public addresses with variables. 🚀

Todo:

Cute Animal Picture

Put a link to a cute animal picture inside the parenthesis-->

@fselmo
Copy link
Collaborator

fselmo commented Aug 5, 2022

[posted in issue... moving it here]

Hey thanks for getting this moving again 😅 ... I'm still seeing a few addresses that are actual addresses in the docs:

  • 0xd3CdA913deB6f67967B99D67aCDFa1712C293601 is still popping up in web3.geth.rst, web3.main.rst, and web3.parity.rst
  • 0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E is still present in web3.eth.account.rst and is a working address on Rinkeby and possibly others
  • 0x2a65Aca4D5fC5B5C859090a6c34d164135398226 is also on Rinkeby possibly others...

I'm not going to keep looking atm but I think there are still quite a few real addresses in the docs. Ideally we can scramble these by replacing one or two letters or numbers.

@B3nac
Copy link
Contributor Author

B3nac commented Aug 5, 2022

No problem! Oh snap, I thought it was only web3.eth.rst heh heh. Ok I'll review web3.geth.rst, web3.main.rst, web3.parity.rst, and web3.eth.account.rst as well. 💯 I might be able to write something that shows the line and file with the public address so I can recursively look through all the docs. 🚀

@B3nac
Copy link
Contributor Author

B3nac commented Aug 18, 2022

This should work egrep -rnw '0x[a-fA-F0-9]{40}' ~/web3.py/docs just need to replace every instance now.

@B3nac
Copy link
Contributor Author

B3nac commented Aug 29, 2022

@fselmo I think I got em all. Let me know what you think, cheers!

@reedsa
Copy link
Contributor

reedsa commented Jun 29, 2023

@B3nac there are merge conflicts/test failures from this being a bit stale. Any chance of coming back to this or should we proceed to take it on?

@B3nac
Copy link
Contributor Author

B3nac commented Jun 29, 2023

Hey @reedsa! Yeah lemme give it the ole college try to resync my branch with justice and glory.

@B3nac B3nac force-pushed the master branch 2 times, most recently from 2484551 to 8089319 Compare June 29, 2023 22:35
@B3nac B3nac closed this Jun 29, 2023
@B3nac B3nac force-pushed the master branch 2 times, most recently from 8089319 to 02e426a Compare June 29, 2023 22:38
@B3nac B3nac reopened this Jun 29, 2023
@B3nac
Copy link
Contributor Author

B3nac commented Jun 29, 2023

I have to go back through each doc page individually because there has been style changes to snake_case for some functions, so this is going to take me awhile.

@B3nac
Copy link
Contributor Author

B3nac commented Jun 30, 2023

@reedsa ok everything should be good now, for the love of bob please merge 🤣.

Seriously though let me know if I missed anything. Cheers!

@reedsa
Copy link
Contributor

reedsa commented Jun 30, 2023

Thanks for taking that on and for the quick update! Appreciate the time you've sunk into this.
One improvement we'd like to make is to adjust these so they render as placeholder variables rather than strings to make it more distinguished.
I noticed the tests for docs are also failing. Before we merge I plan to fix those in addition to updating the address strings to appear more like variables. Will push a commit soon!

@reedsa reedsa merged commit 8371df7 into ethereum:main Jul 5, 2023
@fselmo fselmo mentioned this pull request Jul 5, 2023
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants