Stream: rustdoc

Topic: Code examples RFC


view this post on Zulip Joshua Nelson (Aug 21 2021 at 22:58):

:wave: hey @T-rustdoc, could you take a look at https://github.com/rust-lang/rfcs/pull/3123#issuecomment-895597460 when you get a chance? happy to discuss more on the RFC if you have questions, I just don't want it sitting without a response

view this post on Zulip Joshua Nelson (Aug 21 2021 at 22:59):

thank you @Manish Goregaokar for already taking a look :)

view this post on Zulip GuillaumeGomez (Aug 21 2021 at 22:59):

I have the tab open... I should really finish to read... (a bit ashamed of myself)

view this post on Zulip Joshua Nelson (Aug 21 2021 at 22:59):

no worries! happy to talk it over if things are confusing

view this post on Zulip Noah Lev (Aug 21 2021 at 23:00):

I've been meaning to look more at that one.

view this post on Zulip Joshua Nelson (Aug 21 2021 at 23:00):

@simulacrum I don't know who else is an administrator, but could you add @CraftSpider and @jsha to the T-rustdoc group?

view this post on Zulip Noah Lev (Aug 21 2021 at 23:00):

I like the overall idea, I just feel worried that it could make the docs verbose.

view this post on Zulip Noah Lev (Aug 21 2021 at 23:01):

@Joshua Nelson You can add them yourself.

view this post on Zulip Noah Lev (Aug 21 2021 at 23:01):

Anyone in the group can modify it.

view this post on Zulip Noah Lev (Aug 21 2021 at 23:01):

Just click on Organizational settings and then User groups.

view this post on Zulip Noah Lev (Aug 21 2021 at 23:01):

Then look for T-rustdoc.

view this post on Zulip simulacrum (Aug 21 2021 at 23:01):

@Joshua Nelson could you pm me with that if needed? I'll lose track of this thread but pms are easier to keep track for longer

view this post on Zulip Joshua Nelson (Aug 21 2021 at 23:02):

Noah Lev said:

Joshua Nelson You can add them yourself.

oh TIL, thank you!

view this post on Zulip Joshua Nelson (Aug 21 2021 at 23:02):

simulacrum said:

Joshua Nelson could you pm me with that if needed? I'll lose track of this thread but pms are easier to keep track for longer

@simulacrum it turns out I can do it myself :) thank you though!

view this post on Zulip Joshua Nelson (Aug 25 2021 at 01:48):

Noah Lev said:

I like the overall idea, I just feel worried that it could make the docs verbose.

@Noah Lev is there some change we could make to make it less verbose? It's already opt-in on a per-crate level

view this post on Zulip GuillaumeGomez (Aug 25 2021 at 07:57):

That's what worried me as well alongside the size of the generated docs too.

view this post on Zulip Noah Lev (Aug 25 2021 at 18:35):

Joshua Nelson said:

Noah Lev said:

I like the overall idea, I just feel worried that it could make the docs verbose.

Noah Lev is there some change we could make to make it less verbose? It's already opt-in on a per-crate level

It is opt-in, but IIUC the plan is to enable it by default on docs.rs, and most docs are either there or on doc.rlo. So isn't that kind of like it's not opt-in?

view this post on Zulip Noah Lev (Aug 25 2021 at 18:36):

Unfortunately, I can't really think of anything that would make it less verbose. The only thing I could think of is to add an option to the settings page, but that's not really a solution, just a mitigation.

view this post on Zulip Noah Lev (Aug 25 2021 at 18:36):

I left a review on the RFC with some more comments.

view this post on Zulip GuillaumeGomez (Aug 25 2021 at 19:13):

I didn't pay attention to the docs.rs part being enabled by default

view this post on Zulip GuillaumeGomez (Aug 25 2021 at 19:13):

imo it's definitely not a good idea

view this post on Zulip Joshua Nelson (Aug 25 2021 at 19:20):

Why do you think it's a bad idea?

view this post on Zulip GuillaumeGomez (Aug 26 2021 at 08:16):

For example on gtk-rs, we all quite a lot of examples and a loooooot of functions/objects. So what make the documentation really big.

Another example is that you have only one example which uses all the functions of your crate. You would get the same example on every items of your crate

view this post on Zulip GuillaumeGomez (Aug 26 2021 at 08:16):

I think it's nice, but not in every cases

view this post on Zulip GuillaumeGomez (Aug 26 2021 at 08:33):

The failure this time was simple: it's simply because you used / only whereas on windows it's \\ :p

view this post on Zulip GuillaumeGomez (Aug 26 2021 at 08:33):

So I added the other case too XD

view this post on Zulip GuillaumeGomez (Aug 26 2021 at 18:30):

Doesn't seem like the other #[no_std] have such issues...


Last updated: Oct 11 2021 at 22:34 UTC