YAML bug in docs - Githubissues

wetneb / sheetshow

A renderer for sheet diagrams in bimonoidal categories

https://wetneb.github.io/sheetshow/

MIT License

11 stars 0 forks source link

YAML bug in docs #14

Closed BartoszMilewski closed 3 years ago

BartoszMilewski commented 3 years ago

The first YAML example for a sheet diagram has incorrectly indented outputs line.

wetneb commented 3 years ago

Thanks for noticing and reporting!

BartoszMilewski commented 3 years ago

I meant the first sheet diagram (as opposed to string).

1
2
2 slices:
offset: 1 inputs: 1 outputs: 2 nodes:
- offset: 0 inputs:
- 1 outputs:
- 1
- 1
- offset: 2 inputs: 2 outputs: 2 nodes:
- offset: 0 inputs:
  - 2
  - 2 outputs:
  - 1
  - 1

It has several indentation errors.

wetneb commented 3 years ago

Yes sorry I was too quick off the marks here - I understood what you meant and I think aa70598 fixed it.

BartoszMilewski commented 3 years ago

Have you tested it?

wetneb commented 3 years ago

OK this is becoming really embarrassing. Thanks for pointing it out - again!

BartoszMilewski commented 3 years ago

Not to be a stickler for detail, but the image in the documentation has labels on it.

BartoszMilewski commented 3 years ago

I'd suggest testing all the examples. The user should be able to copy and paste them into the app.

wetneb commented 3 years ago

Yes it obviously makes sense. I am a bit short on time to work on this at the moment but if you feel like to submit a pull request that would be most welcome of course!