Skip to content

API docs Formatting Directives

Matthew Sevey requested to merge sevey-api-doc-cleanup into master

MERGE REQUEST

Overview

This MR adds additional instructions as to how the API docs need to be formatted for proper rendering. It also addresses some formatting errors.

Example for Visual Changes (ie Screenshot)

N/A

Issues Closed

N/A

Checklist

Review and complete the checklist to ensure that the MR is complete before assigned to an approver.

  • All new methods, or updating methods have clear docstrings
  • Testing added or updated for new methods
  • Any new packages are added to Makefile and .gitlab-ci.yml
  • API documentation updated for API updates
  • Module README.md updated for changes to work flow
  • Issue added to Sia-UI repo for new supporting features
  • Changelog File Created
Edited by Matthew Sevey

Merge request reports