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

Update docstrings to new conventions #159

Open
2 of 5 tasks
nalimilan opened this issue Oct 6, 2016 · 2 comments
Open
2 of 5 tasks

Update docstrings to new conventions #159

nalimilan opened this issue Oct 6, 2016 · 2 comments

Comments

@nalimilan
Copy link
Member

nalimilan commented Oct 6, 2016

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
@nalimilan
Copy link
Member Author

Points 1 and 2 have been addressed by #162 (thanks, @RatanRSur!).

@ararslan
Copy link
Member

I hope you don't mind but I converted your list to a checklist for easier tracking of what's been done.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants