Stream: new members

Topic: Iñaki Garay


Iñaki Garay (Apr 09 2019 at 20:10, on Zulip):

Hello everyone! Just call me Aki :) I've been lurking here for a few weeks. Hopefully going to start some documentation efforts soon. My impression is that the mostly the compiler team uses zulip, is this correct?

I'm reading through, in no particular order:
- rust team git repo
- the rustc guide + issues
- mdBook usage and documentation
- the actual rustc code

Any other pointers such as the internals documentation that is not linked in the guide mentioned by Manish would be appreciated. Thanks!

centril (Apr 09 2019 at 20:23, on Zulip):

Hey!

My impression is that the mostly the compiler team uses zulip, is this correct?

Yep; the compiler team and associated working group hangs out here, the libs team on IRC, and everyone else on Discord.

@nikomatsakis do we have any WG for "rustc documentation strikeforce"?

centril (Apr 09 2019 at 20:23, on Zulip):

Documenting rustc is definitely appreciated!

davidtwco (Apr 09 2019 at 20:27, on Zulip):

nikomatsakis do we have any WG for "rustc documentation strikeforce"?

There isn't yet. I can't speak for anyone else, but there has been interest in increasing the focus on documentation. I think as documentation is an ongoing type of work that doesn't have a clear "definition of done" that it's been felt that a working group isn't the right fit.

Santiago Pastorino (Apr 10 2019 at 03:03, on Zulip):

@davidtwco maybe we can discuss some ideas on the next meta meeting but in general I agree with your thoughts

nikomatsakis (Apr 10 2019 at 22:05, on Zulip):

There isn't, but yes I've been wanting to form a WG, and in fact was thiking about trying to make some kind of announcements here.

nikomatsakis (Apr 10 2019 at 22:06, on Zulip):

I actually don't entirely agree with @davidtwco -- I think we've got a kind of 'backlog' of documentation work we should be actively trying to close.

nikomatsakis (Apr 10 2019 at 22:06, on Zulip):

@Iñaki Garay out of curiosity, are you one of the people that I talked with about this at Rust LATAM?

davidtwco (Apr 10 2019 at 22:09, on Zulip):

I’d be happy to see a working group for this. I just thought that it was the type of ongoing task that didn’t really fit the way we’d been describing working groups. If you disagree, that’s great, we can get some folks documenting. :smiley:

Iñaki Garay (Apr 10 2019 at 22:27, on Zulip):

@nikomatsakis precisely :D you have a photo of my name tag. Fede and I have been meaning to write you an email but I've been busy with prep work and dayjob.

centril (Apr 10 2019 at 22:29, on Zulip):

@davidtwco It's not the sort of WG (like NLL) that does its thing and then ends ;) it's a more "continuous" WG. I think there's also a diff between drive-by docs improvements and dedicated "OK; let's take this entire module and document the hell out of it"

Iñaki Garay (Apr 10 2019 at 22:30, on Zulip):

We can also scope out a block of work that could be a wg's purpose

Iñaki Garay (Apr 10 2019 at 22:30, on Zulip):

If that would be useful

centril (Apr 10 2019 at 22:31, on Zulip):

@Iñaki Garay sure, it's a natural part of making a WG to define scope and such

centril (Apr 10 2019 at 22:31, on Zulip):

T-rustdoc recently added a flag for seeing what the docs coverage is

centril (Apr 10 2019 at 22:31, on Zulip):

you can use that to see what places needs docs the most

Santiago Pastorino (Apr 11 2019 at 13:22, on Zulip):

I think all the ongoing work that is in need + specifying concrete and priority work would add up to a nice WG with a more specified scope as @centril have said

Santiago Pastorino (Apr 11 2019 at 13:22, on Zulip):

I wouldn't form a group to document like crazy everything that is around :P

Santiago Pastorino (Apr 11 2019 at 13:22, on Zulip):

probably something with a better purpose is worth a WG

Laurențiu Nicola (Apr 11 2019 at 13:23, on Zulip):

T-rustdoc recently added a flag for seeing what the docs coverage is

Is there a way to make cargo doc pass --show-coverage?

Santiago Pastorino (Apr 11 2019 at 13:23, on Zulip):

like the vision could be, let's make the compiler more accessible to new contributors

QuietMisdreavus (Apr 11 2019 at 13:35, on Zulip):

T-rustdoc recently added a flag for seeing what the docs coverage is

Is there a way to make cargo doc pass --show-coverage?

not directly; you need to use something like cargo rustdoc -- -Z unstable-options --show-coverage

QuietMisdreavus (Apr 11 2019 at 13:38, on Zulip):

you could also use RUSTDOCFLAGS="-Z unstable-options --show-coverage" cargo doc which will spit out coverage for all crates it documents, but that also includes dependencies, so it will probably get out of hand

Santiago Pastorino (Apr 16 2019 at 14:04, on Zulip):

@Iñaki Garay what's your github handle?

Santiago Pastorino (Apr 16 2019 at 14:05, on Zulip):

and @Federico Carrone's I guess

Iñaki Garay (Apr 16 2019 at 14:05, on Zulip):

@igaray

Santiago Pastorino (Apr 16 2019 at 14:05, on Zulip):

or the ones interested in documenting stuff :)

Iñaki Garay (Apr 16 2019 at 14:06, on Zulip):

Fede is @unbalancedparentheses

Iñaki Garay (Apr 16 2019 at 14:07, on Zulip):

Our juniors are @AminArria and @juanbono

Santiago Pastorino (Apr 16 2019 at 14:16, on Zulip):

already commented https://github.com/rust-lang/rust/issues/59864#issuecomment-483678208

Santiago Pastorino (Apr 16 2019 at 14:16, on Zulip):

I guess you and @Federico Carrone may be interested in that

Federico Carrone (Apr 16 2019 at 15:30, on Zulip):

yes, that was actually pretty confusing for me too!

Santiago Pastorino (Apr 17 2019 at 13:30, on Zulip):

@Iñaki Garay @Federico Carrone https://github.com/rust-lang/rust/issues/59864#issuecomment-483835862 feel free to start with this, would be great to have @ehuss confirming that we can use a diagram like that one but you could also build a new one I guess

Federico Carrone (Apr 17 2019 at 14:13, on Zulip):

awesome, thanks. @Iñaki Garay was faster than me and already created a PR

Santiago Pastorino (Apr 17 2019 at 14:31, on Zulip):

link?

Iñaki Garay (Apr 17 2019 at 14:32, on Zulip):

https://github.com/rust-lang/rustc-guide/pull/301 Was just finishing some tidying up

Iñaki Garay (Apr 17 2019 at 14:34, on Zulip):

Other than building locally to verify no broken links and correct rendering there aren't any special steps, correct?
Should I rebase+squash for a single commit or do you squash-merge?

Santiago Pastorino (Apr 17 2019 at 14:35, on Zulip):

so I'd squash but also open separate PRs for each thing

Santiago Pastorino (Apr 17 2019 at 14:35, on Zulip):

one for the stage doc and one for the rest of the broken links and all that

Santiago Pastorino (Apr 17 2019 at 14:35, on Zulip):

actually

Last update: Nov 17 2019 at 06:55UTC