Project

General

Profile

Bug #2763

GMXAPI layout / grouping in development docs "modules" page

Added by Eric Irrgang 11 months ago. Updated 10 months ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
documentation
Target version:
Affected version - extra info:
Affected version:
Difficulty:
uncategorized
Close

Description

There are several strange aspects of the layout of

This is multiple issues (or multiple changes), that will become clearer when a resolution is attempted.

Observations

  • user doc lists several of the "Modules for simulation functionality" but without that grouping. Either the modules weren't intended to be visible at that level or the module group is defined in too narrow a scope.
  • gmx::compat is listed in the user-level doc as "Module_compat" without description. In library and full docs, it appears twice with slightly different entries.
  • "MD Restraints" is the sole sub-item of "Public API," which seems inconsistent with other categorization. Maybe move to the (missing) user-level section for "Modules for simulation functionality"?

History

#1 Updated by Mark Abraham 11 months ago

User doc is uncurated, and will have to go away when we have our new API, so I can't encourage anyone to spend time there.

compat probably started as library only, but the existing poor design means it's probably now in installed headers that again will go away

MD Restraints is the only thing currently there that might survive in the new API, so characterizing it separately seems OK to me.

Basically, there's no time or reason to do a good job of these aspects - let's focus on the future.

#2 Updated by Berk Hess 10 months ago

  • Subject changed from Layout / grouping in development docs "modules" page to GMXAPI layout / grouping in development docs "modules" page

#3 Updated by Paul Bauer 10 months ago

  • Target version changed from 2019 to future

Also available in: Atom PDF