Document whitespace policy, provide editor configurations for non-Python source files

[mkoeppe]

This is a follow-up on #21792.

CC: @embray @dimpase @jdemeyer

Component: scripts

Author: Matthias Koeppe

Branch/Commit: a23bca3

Reviewer: Jeroen Demeyer

Issue created by migration from https://trac.sagemath.org/ticket/21793

[mkoeppe]

Branch: u/mkoeppe/document_whitespace_policy__provide_editor_configurations_for_non_python_source_files

[mkoeppe]

comment:2

Needs review or contributions regarding other editors.

---

New commits:

4052874	Add Emacs configuration - no tabs for indentation
cb55eb7	Add whitespace policy

[mkoeppe]

Commit: cb55eb7

[jhpalmieri]

comment:3

You have to allow tabs in makefiles, so the Emacs configuration should probably apply (indent-tabs-mode . nil) specifically for Python files, Cython files, shell scripts, ReST files, txt files. Any others? (Emacs should recognize a shell script and set the appropriate mode from the line #!/usr/bin/env bash. My copy of Emacs doesn't recognize the file build/make/deps as being a Makefile, and note that this file contains tabs.)

[mkoeppe]

comment:4

Emacs already overrides a globally set indent-tabs-mode in makefile-mode.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

e38309e

Set Emacs file mode

[sagetrac-git]

Changed commit from cb55eb7 to e38309e

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

1d37130

Override indent-tabs-mode for Makefiles

[sagetrac-git]

Changed commit from e38309e to 1d37130

[mkoeppe]

comment:7

But you are right, the directory-local setting was overriding the setting from makefile-mode. Fixed.

[jhpalmieri]

comment:8

This will change the behavior of Emacs on build/make/deps unless the user specifically sets makefile-mode when opening that file. I don't think that's a good idea.

[mkoeppe]

comment:9

Replying to @jhpalmieri:

This will change the behavior of Emacs on build/make/deps unless the user specifically sets makefile-mode when opening that file. I don't think that's a good idea.

Did you see the change that sets the major mode of that file?

[mkoeppe]

Author: Matthias Koeppe

[jhpalmieri]

comment:11

Replying to @mkoeppe:

Replying to @jhpalmieri:

This will change the behavior of Emacs on build/make/deps unless the user specifically sets makefile-mode when opening that file. I don't think that's a good idea.

Did you see the change that sets the major mode of that file?

No, but I see it now.

[jdemeyer]

comment:13

I don't like how this becomes the first section of the "General conventions" document, as if it is the most important thing. I would for example put it right before the section "The Pickle Jar".

Also the title "General Code Style" doesn't really convey that it's about whitespace.

[mkoeppe]

comment:14

Doesn't it belong into the chapter "General Conventions"? Perhaps last section of it?

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

68137f4

Move whitespace section just before pickle jar section

[sagetrac-git]

Changed commit from 1d37130 to 68137f4

[mkoeppe]

comment:16

Replying to @mkoeppe:

Doesn't it belong into the chapter "General Conventions"? Perhaps last section of it?

Please disregard.

I agree with you. Please see the current patch.

[jdemeyer]

Reviewer: Jeroen Demeyer

[jdemeyer]

comment:17

If you checked that the documentation actually builds, you can set this to positive_review.

[sagetrac-git]

Changed commit from 68137f4 to a23bca3

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

3443b24	Add Emacs configuration - no tabs for indentation
13d4f47	Add whitespace policy
b578e49	Set Emacs file mode
2886c37	Override indent-tabs-mode for Makefiles
a23bca3	Move whitespace section just before pickle jar section

[mkoeppe]

comment:19

It does build (just verified again after rebasing to current beta). Thanks.

[vbraun]

Changed branch from u/mkoeppe/document_whitespace_policy__provide_editor_configurations_for_non_python_source_files to a23bca3