search

JuliaRheology / RHEOS.jl

RHEOS - Open Source Rheology data analysis software
MIT License
40 stars 9 forks source link

Standardise docstring content and formatting #101

Closed moustachio-belvedere closed 2 years ago

moustachio-belvedere commented 3 years ago

I noticed today that our docstrings are a bit inconsistent. There are guidelines here, which we should try and follow:

https://docs.julialang.org/en/v1/manual/documentation/

One of the easier things to fix will be formatting, using backticks like this instead of quote marks is visually helpful. Restructuring, adding examples etc will take a bit more time.

moustachio-belvedere commented 3 years ago

As part of this, and with reference to point 6 in the above link, we may want to use self-contained docstring examples as tests, so we can be sure they are always up-to-date.

moustachio-belvedere commented 2 years ago

I had a look through the API section (which, if I remember corrrectly, was where some of the formatting was inconsistent) and it seems to have been fixed at some point.