Mentions légales du service

Skip to content

Update docstrings in each Module/Class

CANSIZ Sergen requested to merge feature/259-update-doc-strings into develop

Changes:

  • Doc strings has been updating by respecting the style Google
  • Script for checking/serving documentation only for API doc

Test script for doc strings is located : ./tests/docstrings/check_docstrings. This script only for checking whether doc strings are parsed correctly. API docs won't be displayed as same as fedbiomed.gitlab.pages.

To do a final check, please clone fedbiomed.gitlabpages repository and run:

git checkout feature/257-api-doc
./fedbiomed_doc.sh --branch feature/259-update-doc-strings serve

The command above will clone feature/259-update-doc-strings into fedbiomed.gitlabpages and serve API doc under User Documentation > Developer > API reference

Edited by CANSIZ Sergen

Merge request reports