[xwiki/xwiki-dev-llm] 111503: [Misc] Make the comment example carry its own expl...
Branch: refs/heads/velocity-code-style-okf Home: https://github.com/xwiki/xwiki-dev-llm Commit: 111503058e22cc437d75201cb70c7975c007acfe https://github.com/xwiki/xwiki-dev-llm/commit/111503058e22cc437d75201cb70c79... Author: Vincent Massol <[email protected]> Date: 2026-09-15 (Tue, 15 Sep 2026) Changed paths: M xwiki/okf/conventions/code-comments.md Log Message: ----------- [Misc] Make the comment example carry its own explanation The example showed an issue ID and title standing in for the reason, which is exactly what the rule above forbids: a title states the symptom, not why the code does what it does. The comment now explains the problem on its own and the issue reference only adds detail. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]> To unsubscribe from these emails, change your notification settings at https://github.com/xwiki/xwiki-dev-llm/settings/notifications
participants (1)
-
XWiki Notifications