Stream: t-compiler/wg-rls-2.0

Topic: docs


divma (Feb 10 2020 at 19:19, on Zulip):

Hi, recently I worked (more like.. _still working on_) an issue in rust_analyzer, and I think it is not that far from landing, but the process would have been easier with a bit more of docs. There are lots of thing I need to use to solve what I'm working on but that I simply can't just figure out what's their intended meaning/usage/etc. Is there any plan on expanding docs coverage? I would love to help in writing such docs simply because doing so would allow me to understand the code base, and then of course, it would help other new-to-ra developers willing to do stuff. Thought?

Jeremy Kolb (Feb 10 2020 at 19:22, on Zulip):

PRs welcome!

matklad (Feb 10 2020 at 20:19, on Zulip):

In general, we are pretty bad with docs.

THe geneneral idea is to maintain module-level docs and the top-level achitecture.md

matklad (Feb 10 2020 at 20:19, on Zulip):

Function level docs unfortunatelly usually get obsoleted pretty quickly :(

matklad (Feb 10 2020 at 20:19, on Zulip):

In general, it's a good idea to send a PR with docs if it took you some time to understand smth

divma (Feb 10 2020 at 21:38, on Zulip):

that's a bit sad to hear, but good to know. I still think there is "improvement opportunity " wrt to documenting concepts that seem to appear in various places and that would benefit from a small doc comment. That being said, i'll send a PR whenever I find places in which that's the case

Last update: Oct 28 2020 at 17:45UTC