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

External References: Explain Comments and Hashes #14

Open
msymons opened this issue Jan 31, 2024 · 0 comments
Open

External References: Explain Comments and Hashes #14

msymons opened this issue Jan 31, 2024 · 0 comments

Comments

@msymons
Copy link
Collaborator

msymons commented Jan 31, 2024

In 0x51-External-References.md...

  • Add coverage of the comment field. Ideally, there should also be a use-case that can demonstrate how the comment might deliver real value.
  • Add coverage of hashes over and above the example already provided. The specification says that hashes are used "if applicable". Thus, it would be useful to explain in the guide when hashes are applicable... and when they are not.

It would also be ueful if the table had an additional column to detail in which version of the specification each External Reference first appeared. eg, I just wasted an hour or two trying to work out why static-analysis-report was giving problems... having not realized that my generating tool only supports up to v1.4 format and the problem reference was introduced in v1.5.

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

No branches or pull requests

1 participant