Skip to content

Fix JSON field name in README.md: change 'includes' to 'include'#550

Merged
luoliwoshang merged 3 commits into
xgo-dev:mainfrom
luoliwoshang:fix-json-field-name
Aug 14, 2025
Merged

Fix JSON field name in README.md: change 'includes' to 'include'#550
luoliwoshang merged 3 commits into
xgo-dev:mainfrom
luoliwoshang:fix-json-field-name

Conversation

@luoliwoshang
Copy link
Copy Markdown
Contributor

Summary

Fixed inconsistent JSON field name in README.md where 'includes' should be 'include' to match the documented configuration format.

Changes

  • Changed 'includes' to 'include' in the libxslt configuration example on line 347

Context

All configuration files throughout the codebase use 'include' as the field name for specifying header files, not 'includes'. This change ensures consistency with:

  • The actual libxslt configuration file in _llcppgtest/libxslt/llcppg.cfg
  • All other configuration examples in the documentation
  • The configuration format specification

Related Issue

Fixes #549

🤖 Generated with Claude Code

Fixed inconsistent JSON field name in line 347 where 'includes' should be
'include' to match the documented configuration format used throughout
the codebase.

Fixes xgo-dev#549

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit comprehensively fixes all instances where 'includes' was used
instead of the correct 'include' field name in JSON configuration examples
and documentation text:

- Line 347: JSON field name (already fixed)
- Line 385: Documentation text describing the configuration
- Line 420: JSON example for correct ordering
- Line 427: JSON example for incorrect ordering

All changes ensure consistency with the actual configuration format used
throughout the codebase.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented Aug 14, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.20%. Comparing base (92b15e6) to head (d56ecfd).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #550   +/-   ##
=======================================
  Coverage   84.20%   84.20%           
=======================================
  Files          27       27           
  Lines        2747     2747           
=======================================
  Hits         2313     2313           
  Misses        391      391           
  Partials       43       43           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Fixed remaining instances of incorrect 'includes' field name in the
design documentation:

- Line 502: JSON configuration example for libxslt
- Line 842: JSON structure example in llcppsigfetch output

This ensures complete consistency across all documentation files
with the actual configuration format used throughout the codebase.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@luoliwoshang luoliwoshang merged commit 89ad1f5 into xgo-dev:main Aug 14, 2025
10 checks passed
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.

Fix JSON field name in README.md: 'includes' should be 'include'

2 participants