graphix icon indicating copy to clipboard operation
graphix copied to clipboard
verified publisher icon TeamGraphix

Enhance documentation

Open EarlMilktea opened this issue 1 year ago • 2 comments

Mentioned in #223 :

  • [ ] Add a helpful section for configuring vscode settings to check for things on editor
  • [ ] Add a section for local checks guide (in addition to PR template): nox, ruff, any other?

My suggestions:

  • [ ] Add doctest
  • [ ] Coherently use numpy style for docstrings
  • [ ] Use hyperlinks in the documentation for better maintenability

EarlMilktea avatar Oct 14 '24 18:10 EarlMilktea

note: first items to be added in contributing guide (both on main repo and in doc)

shinich1 avatar Oct 14 '24 23:10 shinich1

@shinich1 Let me partly work on this after #228 (only for basic modules already refactored)

EarlMilktea avatar Oct 20 '24 05:10 EarlMilktea

Would like to work on this issue

NazTM avatar May 28 '25 16:05 NazTM

@shinich1 I have taken a stab at improving the docs the docs. Could you please approve the workflows?

WingCode avatar May 28 '25 23:05 WingCode