Missing documentation
The documentation is missing for many models. More specifically:
- Short information of the models (docstrings)
- Detailed information of the models
- Revisions of the models
Sometimes only one point is missing but often all points are missing! In the following, I create a task list and add all packages/models that have incomplete documentation sections:
-
Media -
Media.Functions -
Media.Functions.Testers -
Media.Functions.Testers.* -
Media.AdsorbentAdsorbate -
Media.AdsorbentAdsorbate.Partial -
Components -
Components.Cells -
Components.Cells.Adsorbent -
Components.Cells.Adsorbent.Testers -
Components.Cells.Adsorbent.Testers.* -
Components.Cells.Gas -
Components.Cells.Gas.PressureDropCorrelations -
Components.Cells.Gas.PressureDropCorrelations.Partial -
Components.Cells.Gas.PressureDropCorrelations.Partial.* -
Components.Cells.Gas.Geometry -
Components.Cells.Gas.Geometry.CellGeometry -
Components.Cells.Gas.Testers -
Components.Cells.Gas.Testers.* -
Components.Cells.Wall -
Components.Cells.Wall.Wall -
Components.Cells.Wall.Testers -
Components.Cells.Wall.Testers.* -
Components.Cells.VLEPhaseSeparator -
Components.Cells.VLEPhaseSeparator.VLEPhaseSeparator -
Components.Cells.VLEPhaseSeparator.Testers -
Components.Cells.VLEPhaseSeparator.Testers.* -
Components.HeatTransfer -
Components.HeatTransfer.HeatTransferPhenomena -
Components.HeatTransfer.HeatTransferPhenomena.Partial -
Components.HeatTransfer.HeatTransferPhenomena.Partial.* -
Components.HeatTransfer.HeatTransferPhenomena.Tester -
Components.HeatTransfer.HeatTransferPhenomena.Tester.* -
Components.MassTransfer -
Components.MassTransfer.* -
Components.MassTransfer.Partial -
Components.MassTransfer.Partial.* -
Components.MassTransfer.MassTransferPhenomena -
Components.MassTransfer.MassTransferPhenomena.* -
Components.MassTransfer.Testers -
Components.MassTransfer.Testers* -
Components.MassTransfer.Record -
Components.MassTransfer.Record.DiffusionCoefficients -
Components.MassTransfer.Recrod.FlowCoefficients -
Components.ClosedAdsorber -
Components.ClosedAdsorber.* -
Components.ClosedAdsorber.Geometry -
Components.ClosedAdsorber.Geometry.* -
Components.ClosedAdsorber.RecordsTransportCoefficients -
Components.ClosedAdsorber.RecordsTransportCoefficients.HeatTransfer -
Components.ClosedAdsorber.Tester -
Components.ClosedAdsorber.Tester.* -
Components.EvpCond -
Components.EvpCond.EvpCond -
Components.EvpCond.Geometry -
Components.EvpCond.Testers -
Components.EvpCond.Testers.* -
Components.OpenAdsorber -
Components.OpenAdsorber.OpenAdsorber -
Components.OpenAdsorber.Geometry -
Components.OpenAdsorber.* -
Components.OpenAdsorber.HeatAndMassTransfer -
Components.OpenAdsorber.HeatAndsMassTransfer.* -
Components.OpenAdsorber.HeatAndMassTransfer.TransportPhenomena -
Components.OpenAdsorber.HeatAndMassTransfer.TransportPhenomena.HeatTransfer -
Components.OpenAdsorber.HeatAndMassTransfer.TransportPhenomena.MassTransfer -
Components.OpenAdsorber.PressureDropCorrelations -
Components.OpenAdsorber.Testers -
Components.OpenAdsorber.* -
Components.HeatExchanger -
Components.HeatExchanger.HXAirAirParallelflow -
Components.HeatExchanger.HXAirAirParallelflow.Geometry -
Components.HeatExchanger.HXAirAirParallelflow.HeatAndMassTransfer -
Components.HeatExchanger.HXAirAirParallelflow.HeatAndMassTransfer.* -
Components.HeatExchanger.HXAirAirParallelflow.HeatAndMassTransfer.TransportPhenomena -
Components.HeatExchanger.HXAirAirParallelflow.HeatAndMassTransfer.TransportPhenomena.HeatTransfer -
Components.HeatExchanger.HXAirAirParallelflow.PressureDropCorrelations -
Components.HeatExchanger.HXAirAirParallelflow.Testers -
Components.HeatExchanger.HXAirAirParallelflow.Testers.* -
Components.Valves -
Components.Valves.VLE_Valves -
Components.Valves.VLE_Valves.Partial -
Components.Valves.VLE_Valves.Testers -
Components.Valves.VLE_Valves.Testers.* -
Applications -
Applications.AdsorptionChillers -
Applications.AdsorptionChillers.* -
Applications.DesiccantSystem -
Applications.DesiccantSystem.* -
Internals -
Internals.ClassTypes -
Internals.ClassTypes.* -
Internals.SmoothTransition -
Internals.SmoothTransition.* -
Internals.SmoothTransition.Testers -
Internals.SmoothTransition.Testers.* -
Internals.AdditionalTransferPhenomena -
Internals.AdditionalTransferPhenomena.HeatTransfer_insideTube -
Internals.systime
Explenation: name.* indicates that all models of the package 'name' have incomplete documentation sections.