Skip to content
This repository was archived by the owner on Oct 23, 2022. It is now read-only.

Refresh docs #392

Merged
merged 27 commits into from
Sep 23, 2020
Merged

Refresh docs #392

merged 27 commits into from
Sep 23, 2020

Conversation

koivunej
Copy link
Collaborator

@koivunej koivunej commented Sep 22, 2020

Adds at least top level documentation for many types, hides some unnecessary re-exports, removes warnings from nightly rustdoc on bad links, and so on.

Cc: #197 (this leaves us with 185 errors)

@koivunej koivunej requested a review from ljedrz September 22, 2020 14:58
@koivunej koivunej mentioned this pull request Sep 22, 2020
24 tasks
@koivunej koivunej marked this pull request as draft September 22, 2020 15:06
@koivunej
Copy link
Collaborator Author

I'll want to preview this with the #391 in, keeping draft until that.

Copy link
Member

@ljedrz ljedrz left a comment

Choose a reason for hiding this comment

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

Nice 👌, left a few nits

@koivunej koivunej marked this pull request as ready for review September 23, 2020 09:41
@koivunej
Copy link
Collaborator Author

The docs are still looking ok and now have at least top level module writings. I am bit worried docsrs will decide not to show any docs for ipfs::Ipfs since I hid the ipfs::IpfsInner but we'll just have to see. docsrs is using a more recent nightly than I am... but they must have upgraded overnight.

Trying now with 0da580074 2020-09-22, still looking good, no new warnings.

Joonas Koivunen and others added 2 commits September 23, 2020 12:54
Co-authored-by: ljedrz <ljedrz@users.noreply.github.com>
@koivunej
Copy link
Collaborator Author

bors r+

@bors
Copy link
Contributor

bors bot commented Sep 23, 2020

Build succeeded:

@bors bors bot merged commit 43c670d into rs-ipfs:master Sep 23, 2020
bors bot added a commit that referenced this pull request Sep 23, 2020
394: Simplified node internals and creation v3 r=koivunej a=koivunej

Supercedes #345.

Rebased and fixed on top of #392 master.

Co-authored-by: ljedrz <ljedrz@gmail.com>
Co-authored-by: Joonas Koivunen <joonas@equilibrium.co>
@koivunej koivunej deleted the refresh_docs branch September 24, 2020 12:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants