fix(core): update description field to avoid confusion for LLMs and humans #32665
Conversation
|
View your CI Pipeline Execution ↗ for commit 4611c48
☁️ Nx Cloud last updated this comment at |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| "properties": { | ||
| "directory": { | ||
| "description": "The directory of the new application.", | ||
| "description": "Full path to the application folder. When using positional name argument, this path should include the application name as the final segment.", |
There was a problem hiding this comment.
Would this be better to just include an example?
| "description": "Full path to the application folder. When using positional name argument, this path should include the application name as the final segment.", | |
| "description": "The directory of the new application. (e.g." /path/to/new-app"), |
There was a problem hiding this comment.
I thought about it, but then wanted to keep it as short as possible. I need to do some testing how LLMs pick this new description up. And yeah in case I can add an example. The crucial part there is whether the positional name argument is used or not, so you'd need to include that in the example almost.
juristr
force-pushed
the
fix/update-directory-generator-description
branch
from
4b68ad8 to
4611c48
Compare
✅ Deploy Preview for nx-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![nx-cloud[bot]](https://avatars.githubusercontent.com/in/80458?s=60&v=4){kind=small}
There was a problem hiding this comment.
Nx Cloud has identified a possible root cause for your failed CI:
The pull request updates description fields in generator schema files to provide clearer documentation for the directory parameter across multiple Nx generators. These changes are purely textual documentation improvements in JSON schema files.
Both failing tasks are unrelated to the code changes:
The web:test failure occurs due to a corrupted ESLint cache file in the workspace-data directory. The error "ValueExpected in /home/workflows/workspace/.nx/workspace-data/eslint-2654242865465226088.hash at 1:1" indicates an empty or malformed hash file. Schema description text changes cannot cause cache file corruption, as they don't modify any code that generates or manages these cache files.
The e2e-next test failure is caused by an X11 display server connection error in the CI environment ("ERROR:connection.cc(63)] X connection error received"). This is an environmental issue where Cypress cannot connect to the display server to run component tests. Description text in schema files has no impact on display server connectivity or GUI test execution.
These are environmental state issues - corrupted cache files and CI infrastructure problems - that occur independently of the documentation changes made in this pull request. The changes modify only static text descriptions that are displayed to users; they do not alter any executable code paths, test logic, or system interactions that could trigger these failures.
A code change would likely not resolve this issue, so no action was taken.
🎓 To learn more about Self Healing CI, please visit nx.dev
2 participants
Current Behavior
Expected Behavior
Related Issue(s)
Fixes #