Improve readability and consistency of Sugar HTML code style guidelines#239
Improve readability and consistency of Sugar HTML code style guidelines#239wareeshaali2003 wants to merge 1 commit intosugarlabs:masterfrom
Conversation
|
|
||
| This document defines the code style guidelines for HTML-based Sugar | ||
| development. Following these conventions ensures consistency, | ||
| readability, and compatibility with Sugar’s “View Source” feature. |
There was a problem hiding this comment.
Sugar's "View Source" feature? I don't see how that relates here.
You should also look at how your changes show up in markdown, I doubt that's what you intend.
I also don't see how this line improves readability and consistency.
There was a problem hiding this comment.
You’re right about the “View Source” reference. That context doesn’t really add value here, and I’ll remove it to keep the guideline more generally applicable.
There was a problem hiding this comment.
I'm curious, how did you get there in the first place?
|
|
||
| * Avoid lines longer than 80 characters. | ||
| * Avoid lines longer than 80 characters to improve readability, | ||
| especially when viewing source code inside Sugar. |
There was a problem hiding this comment.
I honestly don't see how this is better, stating when viewing source code inside Sugar doesn't mean much as not a lot of contributors do that.
|
|
||
| * Use **two spaces** for indentation. | ||
| HTML files are often deeply nested, and two spaces help keep lines | ||
| under 80 characters. |
There was a problem hiding this comment.
I'm really finding it hard to see how this is better than what's already there.
| * The JavaScript style guide is [here](./javascript-style.md) | ||
| JavaScript code must follow the Sugar JavaScript style guide: | ||
| - [JavaScript Style Guide](./javascript-style.md) | ||
|
|
There was a problem hiding this comment.
I prefer the hyperlink being inline when "JavaScript style guide" is mentioned.
There was a problem hiding this comment.
I’ll push an update shortly that removes these explanatory additions and focuses only on formatting/consistency improvements that clearly add value.
|
Also see making commits, your PR would be better when you write better commit messages. |
|
I'm thinking your contributions were guided, but the guidance was really bad. I've not seen you work on Sugarizer, Sugar or Music Blocks. So to edit documentation for that work seems backwards; cart before horse. Work first on our software products before working on our documentation for people who work on them. |
3 participants
This PR improves structure, formatting, and clarity of the Sugar HTML
code style documentation. No rules were changed—only documentation
quality, consistency, and grammar were improved.