Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Catch all ticket for documentation issues in schemas #10

Open
nden opened this issue May 26, 2020 · 0 comments
Open

Catch all ticket for documentation issues in schemas #10

nden opened this issue May 26, 2020 · 0 comments
Milestone

Comments

@nden
Copy link
Contributor

nden commented May 26, 2020

This is a catch all ticket for documentation bugs/fixes.

  • One example in the remap_axes documentation is not correct - suggest removing it.
    It claims the two examples below are equivalent:
!transform/remap_axes-1.3.0
  mapping: [0, 0, 1]
!transform/concatenate-1.2.0
  forward:
    - !transform/remap_axes-1.3.0
      mapping: [0]
    - !transform/remap_axes-1.3.0
      mapping: [1]
  • The "direction" field in the projection schemas has no description.

  • The order of inputs and outputs in the projection schemas should be specified in the documentation.

  • rotate2d should specify the direction of rotation - counterclockwsise.

  • inputs and outputs of rotations:

    • Rotate2D: the inputs and outputs are always Cartesian (x,y)
    • Rotate3D: the inputs and outputs are always spherical (lon,lat)
    • RotateSequence: the inputs and outputs are Cartesian or spherical
      depending on the value of "rotation_type".

    If this is correct, it may be an idea to say this explicitly in the schemas.

  • In

    https://asdf-standard.readthedocs.io/en/1.5.0/file_layout.html

    under "Tree", it says "The tree must contain exactly one YAML
    document, starting with --- (YAML document start marker) and ending
    with ... (YAML document end marker), each on their own line." But then
    the following example shows the start marker NOT on its own line:

    --- !core/asdf-1.0.0

@nden nden changed the title incorrect remap_axes example in documentation Catch all ticket for documentation issues in schemas Jun 2, 2020
@nden nden transferred this issue from asdf-format/asdf-standard Jul 5, 2020
@nden nden added this to the 1.0.0 milestone Jul 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant