Automattic / Automattic/jetpack

Write Brief: Don't spell check code blocks

Open
#39,994 2 comments 1 reaction 0 assignees View on GitHub
[Extension] AI Assistant [Feature] AI Task
Dominant language
PHP
Stars
1.8k
Forks
898
Avg merge
1d 18h
Merged PRs (30d)
774

Description

Currently we spell check code blocks, which leads to lots of red underlines in those blocks. We might want to ignore them entirely, as well as for other Write Brief features (we probably don't need to check for long sentences or unconfident words either). I would say that the exception maybe for comments, which could be spell checked, but that's likely too much work to deal with.

Contributor guide

Open the contributing guide

Research direction

Start at the Write Brief entry point and trace how spell checking and the other Write Brief checks process code blocks. The work is done when code blocks no longer produce spell-check, long-sentence, or unconfident-word findings, while the treatment of comments is explicitly resolved.

Written by the indexing model from the issue text.

Assessment

Domain
content
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.