@benaryorg @sindarina @miki Because not always you have actual default values but examples in docs.
Top-level
@benaryorg @sindarina @miki Because not always you have actual default values but examples in docs. 9 comments
@benaryorg @sindarina @miki Yep, and observe how people ignore it. Anyone who believes that documentation is actually read is naïve. Everything that can be "self-documenting", i.e., *self explanatory* and obvious should be made/written like that. Any "surrounding" documentation is less likely to be read. @benaryorg That's why I wouldn't put 1.2.3.4 in docs/example configs for... idk, a BGP router or something lol. As I said, it really comes down to the target group, and if I get more confusing/questions about 192.0.2.0/24 and it holds up students or confuses them, I tend to use 1.2.3.4 (it's mostly oral lectures, although I hate giving lectures). |
@ljrk @sindarina @miki In documentation of all places you do have the ability to actually write that this value needs to be changed though.
"Important: insert the IP address of [whatever] here"