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

Fix the example in README.md #478

Merged
merged 1 commit into from
Feb 21, 2023
Merged

Fix the example in README.md #478

merged 1 commit into from
Feb 21, 2023

Conversation

aybehrouz
Copy link
Contributor

Unfortunately, the example in README.md still does not compile. Apparently BN254 has a ScalarField() method now, and should not be passed as a parameter directly.

The example in `README.md` (still) does not compile. `BN254` has a `ScalarField()` method now, and should not be passed directly.
@ivokub
Copy link
Collaborator

ivokub commented Feb 21, 2023

@gbotrel - It is README only change. I think can be merged into master but pinging to be sure that it won't invoke any automatic releases etc.

@gbotrel
Copy link
Collaborator

gbotrel commented Feb 21, 2023

Yep it's fine 👍 thanks for the PR. We should probably find a way to have these examples in a _test.go file to ensure we update them, not the first time...

@gbotrel gbotrel merged commit c02da5f into Consensys:master Feb 21, 2023
@ivokub
Copy link
Collaborator

ivokub commented Feb 21, 2023

Yep it's fine 👍 thanks for the PR. We should probably find a way to have these examples in a _test.go file to ensure we update them, not the first time...

Yep. Maybe we could use package documentation for the actual README, where the examples are documentation examples (Example... function in test files) and then use https://pkg.go.dev/github.com/posener/goreadme to compile into README.md.

Only ugly part with it is that then Go package documentation site has duplicate content (pkg.go.dev/...)

@aybehrouz
Copy link
Contributor Author

Also, this Github Action from the marketplace could be useful, though I don't know if using it is safe or not:

https://github.com/marketplace/actions/markdown-embed-code-from-file

@aybehrouz aybehrouz deleted the patch-2 branch February 21, 2023 18:14
Tabaie pushed a commit that referenced this pull request Feb 28, 2023
The example in `README.md` (still) does not compile. `BN254` has a `ScalarField()` method now, and should not be passed directly.
Tabaie pushed a commit that referenced this pull request Feb 28, 2023
The example in `README.md` (still) does not compile. `BN254` has a `ScalarField()` method now, and should not be passed directly.
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