docs: remove misleading “highlighted” wording in subschema examples#2271
docs: remove misleading “highlighted” wording in subschema examples#2271pranjalisr wants to merge 4 commits intojson-schema-org:mainfrom
Conversation
|
Hi @pranjalisr! Thanks a lot for your contribution! I noticed that the following required information is missing or incomplete: completed checklist items Please update the PR description to include this information. You can find placeholders in the PR template for these items. Thanks a lot! |
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2271 +/- ##
===========================================
- Coverage 100.00% 99.28% -0.72%
===========================================
Files 30 30
Lines 663 698 +35
Branches 205 219 +14
===========================================
+ Hits 663 693 +30
- Misses 0 5 +5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Utkarsh-123github
left a comment
There was a problem hiding this comment.
Hi @pranjalisr
For this issue, the expected fix is to write a highlight function (or use it if it is already present in the codebase) and not to change the doc,
I got confused as in issue label it was mentioned documentation so I thought it's docs change but now I've added highlights. Checked locally, working fine. |
Utkarsh-123github
left a comment
There was a problem hiding this comment.
Hi @pranjalisr
Your PR is currently failing the required checks.
Whenever you get a chance, could you please take a look and address them?
Thanks
I've added all required tests for my code changes, verified locally on cypress, running fine. Please review |
|
@Utkarsh-123github if this works fine then can you please assign me #1988 or #1832 |



What kind of change does this PR introduce?
Docs change
Issue Number:
Screenshots/videos:
N/A
If relevant, did you update the documentation?
Yes
Summary
The examples don’t visually highlight any portion of the schema, so references to “highlighted” subschemas can be confusing. This updates the wording to describe the referenced subschema without implying visual highlighting.
Does this PR introduce a breaking change?
No
Checklist
Please ensure the following tasks are completed before submitting this pull request.