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

Drop need to declare spec feature files #3412

Merged
merged 1 commit into from
Jun 12, 2023

Conversation

dapplion
Copy link
Member

@dapplion dapplion commented Jun 8, 2023

Part of effort to reduce boilerplate steps when adding new spec features

Auto-include all files in spec feature directory. Then expect contributor to declare special include / exclude cases only if required

Copy link
Contributor

@hwwhww hwwhww left a comment

Choose a reason for hiding this comment

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

I like it 👍 ! It solves the pain of adding file paths one by one and sometimes missing some files. Thank you a lot @dapplion!

]

EXTRA_SPEC_FILES = {
BELLATRIX: "sync/optimistic.md"
Copy link
Contributor

Choose a reason for hiding this comment

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

There might be multiple extra spec files of one fork. Maybe use <FORKNAME>: List[Path].

Copy link
Member Author

Choose a reason for hiding this comment

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

Used a string since the file accumulator below is not a List. If there are multiple just do a multiline like in

consensus-specs/setup.py

Lines 1072 to 1078 in efd2429

self.md_doc_paths = """
specs/phase0/beacon-chain.md
specs/phase0/fork-choice.md
specs/phase0/validator.md
specs/phase0/weak-subjectivity.md
specs/phase0/p2p-interface.md
"""

Copy link
Contributor

Choose a reason for hiding this comment

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

I was thinking about changing how we append EXTRA_SPEC_FILES[fork] together. But it's fine now; we can figure it out when we have multiple extra spec files of one fork.

@hwwhww hwwhww merged commit 3442dbb into ethereum:dev Jun 12, 2023
@dapplion dapplion deleted the setup-file-decl branch June 14, 2023 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants