feat: add feedback conversation support #34
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds simple conversation support for the feedback() utility function with a new ..messages argument sink.
The purpose is to handle feedback that may not be resolvable with only one answer and that instead require back-and-forths. This may also prove useful if there are several people reviewing the thesis that may want to add comments to an existing piece of feedback.
Here is how the proposed implementation looks like:
This PR does not break any previous usage of feedback() but simply adds a ..messages argument sink that takes arrays of messages like so:
#feedback( ("Reviewer A", "This section needs more clarity.", "2023-10-30"), ( "Author", "I've added more examples to make it clearer.", "2023-10-31, 10:00AM", ), ( "Reviewer B", "Could you please add figures?", "2023-10-31, 2:00PM", ), ( "Author", "I'll add some in the next revision.", "2023-11-01, 9:00AM", ), )
Where pos0 is author name, pos1 is message content and pos2 is date.
This also means that one can theoretically add a list of messages after the feedback and response arguments (even though I see little use in that).
If the idea seems good, we could think about specific improvements, e.g. define a unique for every author name to make it easier to read when there are several people commenting, among other things.