Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add feedback conversation support #34

Closed
wants to merge 1 commit into from

Conversation

spidersouris
Copy link
Contributor

@spidersouris spidersouris commented Oct 31, 2024

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.

@mrtz-j mrtz-j requested review from otytlandsvik and mrtz-j November 1, 2024 06:14
@mrtz-j
Copy link
Owner

mrtz-j commented Nov 25, 2024

Thanks for the PR. @otytlandsvik and I had a little discussion about this feature and came to the conclusion that it is currently out of scope for the project and would be better suited as a separate package.

@mrtz-j mrtz-j closed this Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants