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

[FEATURE] Support for Markdown Rendering in Fields with SpanQuestion #4722

Open
Tomas0413 opened this issue Apr 16, 2024 · 1 comment
Open
Labels
area: ui Indicates that an issue or pull request is related to the User Interface (UI) team: backend Indicates that the issue or pull request is owned by the backend team type: enhancement Indicates new feature requests

Comments

@Tomas0413
Copy link

Is your feature request related to a problem? Please describe.
I've encountered an issue with markdown rendering in fields that are also configured with a SpanQuestion. Specifically, when a field is set to render as markdown (e.g., using rg.TextField(name="response", title="Response", use_markdown=True)), it displays correctly. However, if the same field is associated with a SpanQuestion for annotation, the markdown rendering does not work, and the text is displayed as plain text. Below is the SpanQuestion configuration used:

rg.SpanQuestion(
    name="response_evaluation",
    title="Highlight the parts of the response that are correct or incorrect:",
    labels={
        "CORRECT": "Correct",
        "INCORRECT": "Incorrect"
    },
    field="response",
    required=True
)

Describe the solution you'd like
I would like the system to support markdown rendering even when the field is linked with a SpanQuestion. This would enable annotators to view and interact with formatted text, preserving the original markdown features while enabling efficient and accurate annotation.

Describe alternatives you've considered
An alternative could be to temporarily render the text as markdown in a separate view to assist annotators with understanding the formatting context, then switch back to plain text for the actual annotation process. However, this is not as seamless and might complicate the annotation workflow.

Additional context
This feature would be particularly beneficial for projects involving detailed examination of chatbot responses and document analysis where understanding the formatting is crucial. Enabling markdown in SpanQuestions would significantly enhance the usability and effectiveness of our annotation tools.

@dosubot dosubot bot added area: ui Indicates that an issue or pull request is related to the User Interface (UI) team: backend Indicates that the issue or pull request is owned by the backend team type: enhancement Indicates new feature requests labels Apr 16, 2024
@amritap-ef
Copy link

Also interested

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: ui Indicates that an issue or pull request is related to the User Interface (UI) team: backend Indicates that the issue or pull request is owned by the backend team type: enhancement Indicates new feature requests
Projects
None yet
Development

No branches or pull requests

2 participants