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

Review 'Concept topic' page #698

Merged
merged 4 commits into from
Jun 4, 2024
Merged

Conversation

jdbaldry
Copy link
Member

  • Fix index file name
  • Use italics for emphasis in example title
  • Remove company name possessive
  • Update linked page text to match title

Rest LGTM

Closes #695

- Fix index file name
- Use italics for emphasis in example title
- Remove company name possessive
- Update linked page text to match title

Rest LGTM

Closes #695

Signed-off-by: Jack Baldry <[email protected]>
Copy link
Contributor

github-actions bot commented May 30, 2024

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/structure/topic-types/concept/index.md $${7.26\space\color{red}(Δ+0.13)}$$ $${11.15\space\color{red}(Δ+0.12)}$$ $${7.85\space\color{red}(Δ+0.05)}$$ $${54.57\space\color{red}(Δ-0.03)}$$ $${8.58\space\color{red}(Δ+0.11)}$$ $${41.12\space\color{red}(Δ+0.72)}$$ $${9.89\space\color{red}(Δ+0.03)}$$
View metric targets
Metric Range Ideal score
AutomatedReadability 6 (very easy read) to 14 (extremely difficult read) 8 or less
ColemanLiau 6 (very easy read) to 17 (extremely difficult read) 9 or less
FleschKincaid 6 (very easy read) to 17 (extremely difficult read) 8 or less
FleschReadingEase 100 (very easy read) to 0 (extremely difficult read) 70 or more
GunningFog 6 (very easy read) to 17 (extremely difficult read) 10 or less
LIX 20 (very easy read) to 60+ (extremely difficult read) 35 or less
SMOG 6 (very easy read) to 17 (extremely difficult read) 10 or less

Copy link
Contributor

@josmperez josmperez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@jdbaldry jdbaldry merged commit 26ee351 into main Jun 4, 2024
6 checks passed
@jdbaldry jdbaldry deleted the jdb/2024-05-review-concept-topic branch June 4, 2024 14:23
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.

Review docs/sources/structure/topic-types/concept/index.md
4 participants