I at all times cherished the phrase “present, do not inform”… it is described rather well in this Wikipedia entry:
Present, do not inform is a method utilized in varied sorts of texts to permit the reader to expertise the story by way of actions, phrases, ideas, senses, and emotions relatively than by way of the writer’s exposition, summarization, and outline. It avoids adjectives describing the writer’s evaluation, however as a substitute describes the scene in such a method that readers can draw their very own conclusions.
I believe it is fascinating within the context of writing posts with code, as a result of in dev posts you are possible typically exhibiting code whereas additionally telling what it does. Simply to say that I believe that is completely okay and do not suppose that runs counter to the phrase.
Now, if somebody was to put in writing out a extremely performant code block and inform us proper under it that it is good and extremely performant, that might kinda break the present, do not inform guidelines… as a substitute, I might recommend to the author that they present us how they measured the efficiency (maybe with some type of benchmark check) and description among the particular advantages it brings of us.
