[config] Extra insctruction for LLM: no markdown in docstring

[pieleric]

It tends to write True and False in docstring, but as we don't
look at docstring after markdown processing, that's more confusing than
helpful.

[Copilot]

Pull request overview

Updates the repository’s Copilot guidance to reduce confusing docstring formatting artifacts when Copilot generates Python code and documentation.

Changes:

• Refines the docstring style instruction to add an additional restriction around markup usage.

[coderabbitai]

Warning

Rate limit exceeded

@pieleric has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 47 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 93d1acd8-5dc2-41bb-8a12-21df76ed2c97

📥 Commits

Reviewing files that changed from the base of the PR and between ca84c76 and 404df66.

📒 Files selected for processing (1)

• .github/copilot-instructions.md

📝 Walkthrough

Walkthrough

The pull request updates the AI instruction guidance in .github/copilot-instructions.md to add a constraint on documentation generation for Python functions and classes. The modification adds a requirement to forbid the use of markdown markers within reStructuredText docstrings, while maintaining the existing directives to follow the reStructuredText style guide and omit type information.

Possibly related PRs

• [config] add basic copilot instructions #3316: Introduced the initial .github/copilot-instructions.md file that this PR refines with additional docstring formatting constraints.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly references the main change: adding LLM instructions to forbid markdown in docstrings, which directly matches the documented modification to copilot-instructions.md.
Description check	✅ Passed	The description is directly related to the changeset, explaining the rationale for the instruction change (preventing confusing markdown formatting like True/False in docstrings).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.

Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/copilot-instructions.md:
- Around line 3-4: The phrase "without the type information and without using
markdown markers" in the instruction "Include docstrings for all functions and
classes, following the reStructuredText style guide, but without the type
information and without using markdown markers" is ambiguous; update the
instruction to explicitly state which inline formatting is forbidden (either "no
inline code formatting at all (no backticks of any kind)" or "no
reStructuredText inline-literal syntax (no double backticks) while allowing
plain backticks for other tooling") and give a short example for the chosen rule
so contributors know whether to avoid ``True``/``False`` (double backticks) or
`True`/`False` (single backtick) in docstrings; reference the existing
instruction string as the target to edit so reviewers can find and change it.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d91c7ca1-2cf0-4ba9-838b-f9d5760c03bc

📥 Commits

Reviewing files that changed from the base of the PR and between e2f969a and ca84c76.

📒 Files selected for processing (1)

• .github/copilot-instructions.md