Hacker News Reader

Comment by amelius | Hacker News Reader

Could you tell something about the level of documentation? For instance, do you have to write a paragraph of documentation for every function that you add to the system? How about adding preconditions and postconditions, and other invariants?

Also, is the code that you add to the repository always inspected by other people? Is that done systematically?

View on HN

It is mandatory that each code change is inspected for correctness, language style and approved by a code owner (all 3 may be the same person, or require multiple, depending on the situation).

But I guess the original programmer can never be the same person as those other 3 roles? :)

Depends if his co-workers lock their screens ;)

You always need to get at least _one_ other engineer to review your code.

OWNER and readability approvals may require additional reviewers but not always.

> Could you tell something about the level of documentation? For instance, > do you have to write a paragraph of documentation for every function that > you add to the system? How about adding preconditions and postconditions, > and other invariants?

It varies a lot by project and by how widely used the code is.

There are few (if any) strictly enforced rules for documentation or invariant checking. You basically have to convince at least one other engineer that what you have is sufficient.

The documentation is _generally_ pretty decent for core libraries, but sometimes you just have to read the code.

Reply on news.ycombinator.com