Skip to content

Vignette's content enhancements  #15

@broncio123

Description

@broncio123

Some amount of editing is required in the written text and the code commands to make it more user-friendly and readable
Here's a list of suggestions

  1. Some of the text may have to be rewritten,
    There seems to be a higher emphasis on introducing the statistical methodology and very little in terms of interpretation of its outputs.

  2. In terms of the commands,

  • Use self-descriptive variable names for input and output variables
    This could help to enhance the readability of code blocks, to emphasise the logic behind commands/functions called.
  • Breakdown long function/command calls via the definition of intermediate variables
    I base this comment on my experience with Python code, for which guidance on code writing standards has been laid out https://realpython.com/python-pep8/#naming-styles

Metadata

Metadata

Assignees

No one assigned

    Labels

    code-reviewissues opened to define actions based on code reviewdocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions