Indents in Python and maintainability

Open
#19 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

No file, test, or entry point is named in the issue. First locate the documentation section that discusses Python syntax, then review its surrounding context and add a balanced treatment of indentation's educational benefits and production maintainability concerns; done means the suggestion is addressed clearly without presenting an unsupported conclusion.

Written by the indexing model from the issue text.

Description

Perhaps mention something about the relative advantages and disadvantages of Python's indenting. Simple syntax may be an advantage for educational purposes but for actual production use in the real world, the more structured syntax is far clearer in intent and much easier to maintain in the long term. I have found (and probably caused) numerous errors in production Python code because of stray indents that cause unexpected behaviour. The lack of start/end tokens around code blocks, instead relying on indents for parsing syntax is an abomination in my view :-)

Dominant language
No language data
Stars
448
Forks
40
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from matloff/R-vs.-Python-for-Data-Science

All issues in matloff/R-vs.-Python-for-Data-Science

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.