Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
Add whitespace policy
Browse files Browse the repository at this point in the history
  • Loading branch information
mkoeppe committed Dec 7, 2016
1 parent 3443b24 commit 13d4f47
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions src/doc/en/developer/coding_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,26 @@ all Python/Cython code that is included with Sage should adhere to the
style conventions discussed in this chapter.


.. _section-coding-general:

General Code Style
==================

Use spaces instead of tabs for indentation. The only exception is for
makefiles, in which tabs have a syntactic meaning different from
spaces.

Do not add trailing whitespace.

Sage provides editor configuration for Emacs, using the file
``.dir-locals.el``, to use spaces instead of tabs. Regarding trailing
whitespace, see https://www.emacswiki.org/emacs/DeletingWhitespace
for various solutions.

If you use another editor, we recommend to configure it so you do not
add tabs to files.


.. _section-coding-python:

Python Code Style
Expand Down

0 comments on commit 13d4f47

Please sign in to comment.