search

Adzz / data_schema

Declarative schemas for data transformations.
Apache License 2.0
86 stars 9 forks source link

Code formatting in Readme #42

Closed Ivor closed 2 years ago

Ivor commented 2 years ago

I noticed that the code block for the second example of Sandwich was broken so decided to quickly fix the indentation and then decided to add elixir highlighting as well.

Feel free to ignore or chop and change as required.

Adzz commented 2 years ago

Hey, thanks for the contribution!

The reason these don't have the elixir tags is that the readme is used to generate both the module doc and livebooks and adding tags messes with that a bit.

You can read about the approach here if it's of interest to you.

I do agree it's nicer to have the syntax highlighting on github but I'd rather have one source of truth for the docs for now.

Ivor commented 2 years ago

I see. Thanks for the reply. I wonder if the first commit without the syntax highlighting but fixing the code snippet is still useful. The first code block in the Readme doesn't seem to display correctly. Either way, the library looks very interesting and I'm keen to use it.

Adzz commented 2 years ago

I wonder if the first commit...

I agree thanks for spotting I will merge that soon