Skip to content

Add docstring for AbstractCFDateTime #46

@haakon-e

Description

@haakon-e

It would be useful with a docstring for AbstractCFDateTime so that any mention of the symbol in the docs can be cross-referenced, for example: [`AbstractCFDateTime`](@ref).

Currently, the help page is auto-generated. Specifically, it would be useful with a user-friendly summary and explanations of the various subtypes of this abstract type.

help?> AbstractCFDateTime
search: AbstractCFDateTime AbstractMatrix AbstractUnitRange AbstractPattern

  No documentation found for public symbol.

  Summary
  ≡≡≡≡≡≡≡

  abstract type AbstractCFDateTime{T, Torigintuple}

  Subtypes
  ≡≡≡≡≡≡≡≡

  CFTime.DateTimeTAI{T, Torigintuple}
  CFTime.DateTimeUTC{T, Torigintuple}
  DateTime360Day{T, Torigintuple}
  DateTimeAllLeap{T, Torigintuple}
  DateTimeJulian{T, Torigintuple}
  DateTimeNoLeap{T, Torigintuple}
  DateTimeProlepticGregorian{T, Torigintuple}
  DateTimeStandard{T, Torigintuple}

  Supertype Hierarchy
  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡

  AbstractCFDateTime{T, Torigintuple} <: TimeType <: Dates.AbstractTime <: Any

ref: openjournals/joss-reviews#8487

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions