Skip to content
This repository was archived by the owner on May 4, 2019. It is now read-only.
This repository was archived by the owner on May 4, 2019. It is now read-only.

Update docstrings to new conventions  #159

@nalimilan

Description

@nalimilan

We should improve our docstrings by adapting them to new conventions from the Julia manual. In particular (not all of these steps need to be done at the same time, though):

  • stop using @doc and -> (except for special cases)
  • give the signature with a four-space indent (instead of backquotes)
  • use imperative form ("return") instead of third person ("returns")
  • remove docstrings for generic functions which do not really add NullableArray-specific information (like unshift!, shift!, pop!, splice!, etc.)
  • add examples as doctests where useful

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