Skip to content

Improve doc aesthetics#850

Merged
tomaka merged 2 commits into
libp2p:masterfrom
tomaka:doc-aesthetics
Jan 14, 2019
Merged

Improve doc aesthetics#850
tomaka merged 2 commits into
libp2p:masterfrom
tomaka:doc-aesthetics

Conversation

@tomaka

@tomaka tomaka commented Jan 13, 2019

Copy link
Copy Markdown
Member

Switches the facade crate to edition 2018 and improves the appearance of the generated documentation.

The documentation will now inline the documentation of the sub-crates (core, mplex, ping, etc.) instead of just showing a line saying extern crate libp2p_core as core;

Also added the libp2p icon.

@ghost ghost assigned tomaka Jan 13, 2019
@ghost ghost added the in progress label Jan 13, 2019
@tomaka

tomaka commented Jan 13, 2019

Copy link
Copy Markdown
Member Author

I wanted to do the same with multiaddr and multihash, unfortunately there's a name conflict between the crate name multiaddr and the macro multiaddr!.

@tomaka tomaka merged commit 60db872 into libp2p:master Jan 14, 2019
@tomaka tomaka deleted the doc-aesthetics branch January 14, 2019 13:10
@ghost ghost removed the in progress label Jan 14, 2019
dvdplm added a commit to dvdplm/rust-libp2p that referenced this pull request Jan 15, 2019
* upstream/master: (35 commits)
  Bump libp2p-secio and libp2p-core-derive (libp2p#857)
  Fixes to Kademlia queries (libp2p#855)
  Cache the secp256k1 object in secio (libp2p#856)
  Fix custom derive when using a where clause (libp2p#853)
  Bump to 0.2.2 (libp2p#852)
  Bump to v0.2.1 (libp2p#851)
  Add IntoNodeHandler and IntoProtocolsHandler traits (libp2p#848)
  Improve doc aesthetics (libp2p#850)
  Fix compilation of ring (libp2p#846)
  Add some benchmarks for secio (libp2p#847)
  Version 0.2 (libp2p#841)
  Forbid dialing self (libp2p#839)
  Add an Error associated type to transports (libp2p#835)
  Update ring to 0.13 (libp2p#674)
  Move tests to separate files (libp2p#827)
  multistream-select: Less allocations. (libp2p#800)
  Add more methods on Topology (libp2p#826)
  Documentation improve to ping and minor improvements (libp2p#831)
  Floodsub now produces FloodsubEvent (libp2p#823)
  Add RawSwarm::incoming_negotiated (libp2p#821)
  ...
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.

2 participants