Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite docstrings to facilitate API reference generation #254

Open
alexhroom opened this issue Aug 2, 2024 · 2 comments
Open

Rewrite docstrings to facilitate API reference generation #254

alexhroom opened this issue Aug 2, 2024 · 2 comments

Comments

@alexhroom
Copy link
Collaborator

cf. RascalSoftware/RAT-Docs#1 ; if API reference is autogenerated, then some kind of docstring formatting convention should be used to improve the way it is formatted in the documentation. This can be in the RST docstring style, or the Numpy or Google style (and we can then use the Sphinx extension napoleon to convert)

@StephenNneji
Copy link
Collaborator

We have agreed to use the numpy style to be consistent with Python API and RasCAL

@StephenNneji
Copy link
Collaborator

The user facing functions should be priority for docstring refactoring. This should help keep track of what's left and who is doing what

  • RAT.API.projectClass.backgroundsClass
  • RAT.API.projectClass.baseContrasts
  • RAT.API.projectClass.contrastsClass
  • RAT.API.projectClass.customFileClass
  • RAT.API.projectClass.dataClass
  • RAT.API.projectClass.domainContrastsClass
  • RAT.API.projectClass.domainsClass
  • RAT.API.projectClass.layersClass
  • RAT.API.projectClass.multiTypeTable
  • RAT.API.projectClass.parametersClass
  • RAT.API.projectClass.projectClass
  • RAT.API.projectClass.resolutionsClass
  • RAT.API.projectClass.tableUtilities
  • RAT.API.createProject
  • RAT.API.RAT
  • RAT.API.RATMain
  • RAT.API.controlsClass
  • RAT.API.enums
  • RAT.targetFunctions.reflectivityCalculation

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

No branches or pull requests

2 participants