-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rewrite best practices to encourage tabs #74
Conversation
While still allowing spaces, and just promoting consistency. Fixes #73
I am heavily conflicted on this. I fully support the goal of improving accessibility, but I don't know enough about the available tools to say this is the best solution. |
Yes, agreed. As written, both of these changes only affects tool XML related sections. One is specifically in the |
The "Tabs for XML indentation" would work for me! |
This means only the XML tags inside the XML files, so not the cheetah and the rst section? |
Good question, can the cheetah and RST be done with either tabs or space indentation from a technical point of view? The RST specification says at https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#whitespace that:
It may be pragmatic to recommend tabs only for the XML tags, and spaces for embedded RST? |
I'd like to see it recommended for the cheetah sections as well (that's always worked fine) and since by their documentation it works fine for rST, I'd argue we should provide a more consistent guidance, namely:
|
I think we are pretty much a Python community (cheetah, rst ...) and they recommend spaces instead of tabs. I don't see why we should recommend tabs here. Maybe we can remove the current recommendation and just not recommend anything, just staying stay consistent. Overall the important part is that people can use what they can deal with best. |
This discussion in a large part was started by wanting to make things more accessible to everyone, and more welcoming for those users, hence making that the recommendation, but allowing it open to personal choice.
As it stands, with the text as it is now, any contributor would be free to stick with spaces. But by having the recommendation we can at least push for some small tiny amount of slow change in a positive direction. The only time having this "recommendation" would be bad, is if a reviewer decided to ignore that it is a "recommendation" and make it mandatory for a contributor. |
given the lack of motion on this, I will close it. |
While still allowing spaces, and just promoting consistency. Fixes #73