Use JSX comments for docstrings

Open Beginner friendly
#11,104 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
javascript
Domain
documentation

Research direction

Search the documentation files for HTML comments used around Python snippets, then inspect docs-website/docusaurus.config.js at the linked compatibility setting. Replace the identified comments with JSX comments, remove that setting, and verify that the documentation builds successfully with strict MDX comments enabled.

Written by the indexing model from the issue text.

Description

P2 type:documentation

We are not compatible with strict MDX since we use HTML comments in docstrings in relation to Python snippets testing.

See https://docusaurus.io/blog/releases/3.10#strict-comments.

We should:

Dominant language
Python
Stars
26.6k
Forks
3.2k
Avg merge
1d 2h
Merged PRs (30d)
188

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from deepset-ai/haystack

All issues in deepset-ai/haystack

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.