You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "eschutho (via GitHub)" <gi...@apache.org> on 2025/09/18 23:58:49 UTC
[PR] docs: Add instruction to avoid time-specific language in code comments [superset]
eschutho opened a new pull request, #35200:
URL: https://github.com/apache/superset/pull/35200
### SUMMARY
Added guidance to LLM documentation (LLMS.md) instructing AI assistants to avoid using time-specific words like "now", "currently", and "today" in code comments, as these become outdated over time. Comments should be written to remain accurate regardless of when they're read.
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
N/A - Documentation change only
### TESTING INSTRUCTIONS
1. Review the updated LLMS.md file
2. Verify the new "Code Comments" section appears under "Code Standards"
3. Confirm the guidance is clear and actionable for LLM tools
### ADDITIONAL INFORMATION
- [ ] Has associated issue: No
- [ ] Required feature flags: N/A
- [ ] Changes UI: No
- [ ] Includes DB Migration: No
- [ ] Introduces new feature or API: No
- [ ] Removes existing feature or API: No
This is a documentation improvement to help maintain code quality when using LLM assistants for development.
🤖 Generated with [Claude Code](https://claude.ai/code)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: Add instruction to avoid time-specific language in code comments [superset]
Posted by "eschutho (via GitHub)" <gi...@apache.org>.
eschutho merged PR #35200:
URL: https://github.com/apache/superset/pull/35200
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org