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.

Sign up for GitHub

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

Jump to bottom

Ensure comment Spec pseudocode definition... aligns with upsteam #5717

Closed
terencechain opened this issue May 2, 2020 · 0 comments · Fixed by #8722
Closed

Ensure comment Spec pseudocode definition... aligns with upsteam #5717

terencechain opened this issue May 2, 2020 · 0 comments · Fixed by #8722
Assignees
@farazdagi

Comments

@terencechain
Copy link
Member

🚀 Feature Request

Description

Write an analysis tool to ensure Prysm's code comment for Spec pseudocode definition... is correctly aligned with the up-steam python spec definition of a given commit

Screen Shot 2020-05-02 at 10 27 45 AM

Describe the solution you'd like

I don't have a solution yet since I'm not well versed in this field. Here is what @prestonvanloon suggested:

  • go ast library can read comment
  • scan prysm files for comments with python function definition, then check upstream spec definition and do a basic diff
@terencechain terencechain added the Help Wanted Extra attention is needed label May 2, 2020
@farazdagi farazdagi self-assigned this Sep 28, 2020
@farazdagi farazdagi removed the Help Wanted Extra attention is needed label Sep 28, 2020
@rauljordan rauljordan modified the milestones: Diamond, Backlog Nov 3, 2020
@farazdagi farazdagi mentioned this issue Apr 8, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@farazdagi farazdagi

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Spec checker tool prysmaticlabs/prysm
3 participants
@farazdagi @rauljordan @terencechain