mps icon indicating copy to clipboard operation
mps copied to clipboard

Log documents in proc.review are not prompting editors to complete all edits

Open thejayps opened this issue 2 years ago • 2 comments

See https://github.com/Ravenbrook/mps/pull/166#issuecomment-1773701151

thejayps avatar Oct 22 '23 20:10 thejayps

A way to solve this could be to insist that all comments, defects, questions are listed in the "review changes" comments box when submitted at the end of checking. "Inline" comments/defects should also be noted and referenced in the full list in the comments box, because github causes these to be hidden after conversations are resolved. This could obscure the log history if elements of checking output are mentioned only inline.

The leader or scribe shoukd then copy and paste a full list from all checkers into a new comment box, then generate another new comment box for any defects found during logging. This means some duplication must be tolerated, but it ensures that the entire output of checking and logging is available to the editor in only 2 comment boxes

thejayps avatar Oct 22 '23 21:10 thejayps

In-line comments work OK for editing on GitHub because they show up as "unresolved conversations" in the pull request summary. You are forced to tick them off by closing each conversation. However, this could hide them from the leader during exit.

The leader or scribe shoukd then copy and paste a full list from all checkers into a new comment box, then generate another new comment box for any defects found during logging. This means some duplication must be tolerated, but it ensures that the entire output of checking and logging is available to the editor in only 2 comment boxes

That's similar to the tried-and-tested method of having the scribe log every issue.

I think it would be acceptable for the scribe to edit and append to a single comment with new issues. Then there would be a single comment / text block with a complete log, which would be a good thing.

I would strongly encourage linear numbering of that text with numbered list markup.

rptb1 avatar Oct 23 '23 10:10 rptb1