Skip to content

Book style

Robin edited this page Mar 6, 2022 · 2 revisions

Code

The code does not have to be self-standing: it can depend on code run previously in the chapter.

The code in each chapter is self standing: no chapter should depend on running code in previous chapters.

Text

  • Use one line per sentence during development for ease of tracking changes.

  • Leave a single empty line space before and after each code chunk.

  • Format content as follows:

    • package_name
    • class_of_object
    • function_name
  • Spelling: use en-us

Captions

Captions should not contain any markdown characters, e.g. * or *. References in captions also should be avoided.

Figures

File names

References

Clone this wiki locally