mathworks / mathworks/Emacs-MATLAB-Mode

Question: bringing `matlab-code-indent` style to the MATLAB Editor

Open
#73 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Emacs Lisp
Stars
26
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Hi, first of all, thank you for the great work on Emacs-MATLAB-Mode and for writing up doc/matlab-code-indent.org. I really like the formatting philosophy described there, especially the rules for function argument indentation, alignment of consecutive statements, and the reduced indentation for switch / case blocks.

In my team, though, not everyone uses Emacs. Some people work only in the MATLAB Editor and rely on its built-in formatting. This creates a practical problem: Emacs users format code according to the matlab-code-indent standard, while MATLAB Editor users format according to the Editor’s own rules, and the two styles do not fully match.

I’m wondering how you think about this situation. Do you see any good way to bring the matlab-code-indent style (or something very close to it) into the MATLAB Editor, so that non-Emacs users can share the same formatting standard? For example, do you know of any existing settings, plugins, or workflows that help align the MATLAB Editor’s formatting with the style described in matlab-code-indent.org? Or is this something that might be considered in future, either within this project or on the MATLAB side?

I’m not asking for a specific feature request here; I’m mostly interested in your perspective and any guidance you might have for teams where both Emacs and the MATLAB Editor are used together.

Thanks again for your work on this project.

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.

Research direction

Start by reading doc/matlab-code-indent.org and comparing its stated formatting rules with the MATLAB Editor’s capabilities. The issue provides no concrete implementation target, named code entry point, or completion criteria, so there is no defined change to verify as done.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs, emacs-lisp
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.