[GNC-dev] Sample Report with Examples

[flywire]

I understand you didn't appreciate the post was about the PR just
submitted, not the linked and quoted post 16 months earlier foreshadowing
the PR for context. No concerns had been raised so there was no reason to
provide the detail given until your comment. There is still scope for
discussion.

John Ralls wrote:

> To address point 1 one would change the file name.
> To address point 2 that new file name would be something like
> "sample-report-with-examples.scm".
> To address point 3 one would change the names of the sections.


Fair comments. I expect the report was intended to demonstrate a different
report name and filename. If the filename was changed then something
similar to the existing filename people could still relate to old
documentation. Renaming the section was suggested in the PR comments.

> * 'Hello, World' string is used three times (and in a comment): as a
> string, report title, and report name. It is much easier to see what output
> unique strings are associated with without even understanding the structure
> of the report.


> But that claim is silly, because the user can (and should) open the
> options dialog, change one of the options, click Apply, and observe what
> changes in the report.
>

The point is not about the changes options make to reports, it's about how
the report source code changes the report and report options. Why wouldn't
unique string values help people unfamiliar with reports see
the relationship more clearly?