Chad Elzinga on 29 Jul 2022 00:07:04
Short version:
Add a text box for Comment to the M Query properties dialog and store that text in the advanced editor. Also, rename the Description text box in the query steps to Comment.
Long version:
The description associated with the query steps is fundamentally different than the description associated with the M query. On the step, it's actually a code comment that gets embedded in the text of the query, since it can be seen in the advanced editor. By comparison, the description associated with the query is carried over to the data model and becomes the mouse-over tooltip of the table in the data model.
I would keep the description associated with the query, but add a comments text box where you can leave query-level comments to other people who may end up working on the queries. This text could be stored in the script that defines the query and show up in the advanced editor above the first "let" statement.
For consistency, I would change the label on the text associated with the query steps from Description to Comment, since it would be a more accurate representation of the contents of that text box.