Skip to content

Further refactoring of tools.md #333

@mmesiti

Description

@mmesiti

A lot of good suggestions, and I wish all of these were in separate comments so it could have been easily voted upon. It's not, so here are my 2 cents

yes

unclear, but maybe

  • In code documentation is discussed anyway in the following episode. This could be moved ahead of this one?

    • I guess you mean to move in-code section to the end? Maybe. Human readable prose-like docs should wrap around docs generated from in-code docs.
    • One can also argue that parsing in-code docs is a feature of certain tools. And it follows different conventions / styles. If so the order should be markup formats, readme etc, in-code docs, tools and that I can buy.
  • notebooks/literate programming as a category.

    • sure, as another format, as long as we don't repeat the Jupyter lesson and not lengthen the course, which we don't want do we?

Originally posted by @ashwinvis in #310

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions