Skip to content

Guidance on writing: person, passive/active voice... #199

Open
@OriolAbril

Description

@OriolAbril

Is there a preferred way to address users? Especially for tutorials where we want to give instructions to the reader. Guidance on commenting and explaining code: explanation in markdown above the code cell? below? general explanation in markdown only and implementation details as comments within the code? glossary terms, how do we know if a term should be explained in the notebook or in the gossary, or in both even. other potentially controversial topics?

cc @martinacantaro

It doesn't need to be very extensive and it can even be mostly links to other pages, but I think it will make both writing and reviewing notebooks easier

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions