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

Pull in recent template updates #44

Merged
merged 82 commits into from
Apr 19, 2023
Merged

Conversation

pacrob
Copy link
Contributor

@pacrob pacrob commented Apr 13, 2023

What was wrong?

The project template was recently updated. This PR pulls in those updates.

How was it fixed?

Template update process

Cute Animal Picture

image

carver and others added 30 commits May 3, 2019 14:45
Skip venv in template filler & print progress
Some hard-coded references to web3.py slipped through. Clearly this user path is not tested very often. In eth-abi, it still said EthereumAlarmClock X)
…n-docs

Replace web3 reference with <MODULE_NAME>
…-and-lint-deps

Update testing and lint deps
Better error if bump missing in make notes/release
Latest mypy refuses package with file path
It has weird capitalization rules, in particular.
@pacrob pacrob force-pushed the upgrade-template branch 2 times, most recently from 9b4784f to a7f7305 Compare April 13, 2023 18:37
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured out why this file was there, lol. This file gets auto-generated every time make docs is run. So we can either: a) figure out how to stop that, b) remember to delete it each time make docs is run, or c) just leave it committed so we don't have to worry about it. Option a is probably the "correct" answer, but I think c is almost as good in the short term.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sphinx-apidoc command won't overwrite existing files unless you force it to. So I just renamed types.rst to eth_typing.rst and changed reference name in index.rst. It looks like it's working fine to me.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yay! Thanks for figuring that out!!

@pacrob pacrob force-pushed the upgrade-template branch 2 times, most recently from 5d2d10b to 6fb566b Compare April 14, 2023 20:42
@pacrob pacrob force-pushed the upgrade-template branch 13 times, most recently from 0e0030c to 29222b8 Compare April 18, 2023 17:44
Copy link
Contributor

@kclowes kclowes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for all of these! I left a few comments, but they're the same as the other comments I left in eth-abi and py-ssz, so I think they actually belong in the template update you've got going on.

I'm getting the same doc warning that I mentioned somewhere else too: WARNING: html_static_path entry '_static' does not exist.

.gitignore Outdated

# mpeltonen/sbt-idea plugin
### mpeltonen/sbt-idea plugin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same nit from somewhere else: I think this is covered on line 86.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed

showcontent = true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we also need a deprecation category here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

@pacrob pacrob merged commit 2aa4e98 into ethereum:master Apr 19, 2023
@pacrob pacrob deleted the upgrade-template branch April 19, 2023 18:09
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.

8 participants