Add links in documentation

[joshlf]

Currently, most documentation comments do not include hyperlinks to other documentation when referencing other Rust objects.

[lambdude]

I'm working on this.

[joshlf]

Awesome, thanks!

[joshlf]

Now that implied short links (rust-lang/rust#48335) have been merged, this should be easier.

[JaromirCharles]

Is there still work to be done on this issue?

[joshlf]

@lambdude Have you continued working on this?

[lambdude]

Sorry, I have not been able to continue working on this.

[JaromirCharles]

@joshlf I'd like to pick up this issue then.

[joshlf]

It's all yours then! I'll warn you that you might want to leave the elfmalloc crate to the end because we're in the middle of a large refactor now, so there's a decent chance those changes will land while you're working on this. Of course, if they haven't by the time you get there, then cool.

[JaromirCharles]

@joshlf I've started to work on this issue and I have a question to ensure that i'm doing the right thing.
Here you can look into my branch on which the work is being done. Within the lines [8, 40] you can see that I've added links to the mentioned rust objects.
According to the new short links, i should be able to write [std::println] instead of [println] and then [println]: ../std/macro.println.html. Unfortunately it's not working.
If I'm doing it wrong, can you please leave an example of how it's done so that I can continue with that notation instead of the current one I'm doing. Thanks

[joshlf]

Hmm, unfortunately I'm not sure. I've never actually tried to do this myself (in this project or any other one), so I don't know any more about it than you do. I often find the rust-lang users' forum to be a good resource for this sort of stuff - if you post a simple example of what you expect to work that doesn't work, somebody will probably be able to tell you where you're going wrong.

[JaromirCharles]

@joshlf
Unfortunately i did not have much time the past few days.
I just made a PR with the changes made to alloc-fmt. If you're satisfied with the way it is, i'll get the others done asap in the same manner.

[joshlf]

Awesome, thanks for that PR! My only comments were with the commit messages; the code itself seemed to work perfectly. And don't feel rushed in this 😀 Lord knows I've not had time for this over the past few weeks.

[JaromirCharles]

@joshlf i think i messed up the merging of the commits.

[joshlf]

@JaromirCharles Sorry I went AWOL for a bit, but it looks like you figured it out, so I merged the PR 😃 . Thanks!

[JaromirCharles]

@joshlf Whats the best way of moving forward?
My thought was to create a new branch for each crate and then merge them together as the PR goes through. The only problem would be that the merge commit would be the last commit message no?

[JaromirCharles]

Below is the current log trace after the merge of alloc-fmt and alloc-tls:

JaromirCharles    alloc-fmt: Add links to documentation    a5d0114
JaromirCharles    alloc-tls: Add links to documentation    3d5ced2
JaromirCharles    Merge branch 'alloc_fmt_docu' into alloc_tls_docu    33b0b3c