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

Check formatting configuration #1199

Open
RaananW opened this issue Sep 24, 2024 · 1 comment
Open

Check formatting configuration #1199

RaananW opened this issue Sep 24, 2024 · 1 comment
Assignees
Milestone

Comments

@RaananW
Copy link
Member

RaananW commented Sep 24, 2024

See #1197 (comment)

@RaananW RaananW added this to the 8.0 milestone Sep 24, 2024
@RaananW RaananW self-assigned this Sep 24, 2024
@thomlucc thomlucc modified the milestones: 8.0, Future Oct 8, 2024
@RaananW
Copy link
Member Author

RaananW commented Nov 20, 2024

@deltakosh - I checked the file in question. Prettier actually did what it should do, the file is incorrectly formatted:

original file:

## Animation
### Bones
Provides a world matrix for each vertex, based on skeletal (bone/joint) animation.
    -   Inputs:
        -   matricesIndices: Vector4
        -   matricesWeights: Vector4
        -   matricesIndicesExtra: Vector4
        -   matricesWeightsExtra: Vector4
        -   world: Matrix
    -   Outputs:
        -   output: Matrix

which formats it to:

## Animation

### Bones

Provides a world matrix for each vertex, based on skeletal (bone/joint) animation. - Inputs: - matricesIndices: Vector4 - matricesWeights: Vector4 - matricesIndicesExtra: Vector4 - matricesWeightsExtra: Vector4 - world: Matrix - Outputs: - output: Matrix

According to the standard, the initial - character needs to be the first character of the new line. if the file originally was this (correct markdown):

## Animation
### Bones
Provides a world matrix for each vertex, based on skeletal (bone/joint) animation.
-   Inputs:
    -   matricesIndices: Vector4
    -   matricesWeights: Vector4
    -   matricesIndicesExtra: Vector4
    -   matricesWeightsExtra: Vector4
    -   world: Matrix
-   Outputs:
    -   output: Matrix

Prettier formats it to this:

## Animation

### Bones

Provides a world matrix for each vertex, based on skeletal (bone/joint) animation.

- Inputs:
  - matricesIndices: Vector4
  - matricesWeights: Vector4
  - matricesIndicesExtra: Vector4
  - matricesWeightsExtra: Vector4
  - world: Matrix
- Outputs:
  - output: Matrix

You can also see it in the github markdown parser (the following is the example of how it looks incorrectly, and correctly after formatting)

Provides a world matrix for each vertex, based on skeletal (bone/joint) animation.
- Inputs:
- matricesIndices: Vector4
- matricesWeights: Vector4
- matricesIndicesExtra: Vector4
- matricesWeightsExtra: Vector4
- world: Matrix
- Outputs:
- output: Matrix

Provides a world matrix for each vertex, based on skeletal (bone/joint) animation.

  • Inputs:
    • matricesIndices: Vector4
    • matricesWeights: Vector4
    • matricesIndicesExtra: Vector4
    • matricesWeightsExtra: Vector4
    • world: Matrix
  • Outputs:
    • output: Matrix

What I can suggest is to format everything, making sure our markdown is conform.

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

2 participants