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

Change the reference document link #533

Merged
merged 4 commits into from
Jun 16, 2021
Merged

Change the reference document link #533

merged 4 commits into from
Jun 16, 2021

Conversation

ashWhiteHat
Copy link
Contributor

@ashWhiteHat ashWhiteHat commented Jun 5, 2021

Hi there!
I modified the document link and fixed some typos.
When I click the document link, there is a 404 error so I set the link about it.
But I don't know about the other bellow three documents link.

And when I ran $make doc command the error happened because of the toolchain version problem.
The error is following and the issue is here.

(base) ➜  plonk git:(master) make doc
   Compiling syn v1.0.72
    Checking crossbeam-epoch v0.9.5
error[E0433]: failed to resolve: could not find `addr_of` in `ptr`
   --> /Users/user/.cargo/registry/src/github.aaakk.us.kg-1ecc6299db9ec823/crossbeam-epoch-0.9.5/src/internal.rs:620:59
    |
620 |         let local_ptr = (entry as *const Entry as usize - offset_of!(Local, entry)) as *const Local;
    |                                                           ^^^^^^^^^^^^^^^^^^^^^^^^ could not find `addr_of` in `ptr`
    |
    = note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)

error[E0433]: failed to resolve: could not find `addr_of` in `ptr`
   --> /Users/user/.cargo/registry/src/github.aaakk.us.kg-1ecc6299db9ec823/crossbeam-epoch-0.9.5/src/internal.rs:613:59
    |
613 |         let entry_ptr = (local as *const Local as usize + offset_of!(Local, entry)) as *const Entry;
    |                                                           ^^^^^^^^^^^^^^^^^^^^^^^^ could not find `addr_of` in `ptr`
    |
    = note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)

error: aborting due to 2 previous errors

For more information about this error, try `rustc --explain E0433`.
error: could not compile `crossbeam-epoch`

To learn more, run the command again with --verbose.
warning: build failed, waiting for other jobs to finish...
error: build failed
make: *** [doc] Error 101

Please confirm.
Thank you!

Copy link
Contributor

@CPerezz CPerezz left a comment

Choose a reason for hiding this comment

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

Hi, thanks for the PR!

LGTM but the toolchain needs to be changed to match

nightly-2021-06-06

rust-toolchain Outdated Show resolved Hide resolved
@CPerezz
Copy link
Contributor

CPerezz commented Jun 7, 2021

Also, please add the changes under Unreleased section in CHANGELOG.md

@CPerezz CPerezz self-assigned this Jun 7, 2021
@CPerezz CPerezz added area:documentation Anything to improve our doc base fix:bug Something isn't working labels Jun 7, 2021
@ashWhiteHat
Copy link
Contributor Author

Hi @CPerezz
Thank you for the review.
I fixed it according to your review.
Please confirm.
By the way, is there any developer community like discord?
I'd like to ask some questions about this implementation 😎
Thank you!

@CPerezz
Copy link
Contributor

CPerezz commented Jun 9, 2021

Hi, all seems nice. I'd maybe ask for an edit of the commit message of e38fe5c to something like: Update CHANGELOG.md. Which follows the same format as the others.

For the rest, looks fine!

By the way, is there any developer community like discord?
I'd like to ask some questions about this implementation sunglasses
Thank you!

You can use Github Discussions!! We don't have any other places that I'm aware.

@CPerezz CPerezz self-requested a review June 9, 2021 17:31
Copy link
Contributor

@CPerezz CPerezz left a comment

Choose a reason for hiding this comment

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

LGTM

Please, address:

Hi, all seems nice. I'd maybe ask for an edit of the commit message of e38fe5c to something like: Update CHANGELOG.md. Which follows the same format as the others.

Once addressed, this can be merged!!
Thanks for your contribution! 😄

@ashWhiteHat
Copy link
Contributor Author

Hi @CPerezz
Thank you for the review!
I changed the commit message according to your review.
Please confirm!

@CPerezz CPerezz merged commit cb5a917 into dusk-network:master Jun 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation Anything to improve our doc base fix:bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants