Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Adopt a code standard for implementation codes (umbrella issue) #117

Open
@tcNickolas

Description

@tcNickolas

Basic level:

  • enclose code in ``` tags instead of pre, code etc.
  • code style: spacing, indentation etc.

Intermediate level:

  • unify the way code reads parameters and reports output. A lot of code has comments instead of reading input - we could, for example, wrap such code in a function which accepts a certain list of parameters, so that we don't need a specific input-handling code, and still the code is complete and can be used as a library method.
  • use the same language for all generic code (i.e. code which doesn't highlight some specific feature of a specific language). Some articles have the same code in C++ and Python, and the difference is purely syntax.

Advanced level:

  • make sure all code compiles and is covered by unit tests :-) We could use Jupyter to embed executable code in our articles.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp