Use black for formatting about hsf-training-ml-webpage HOT 14 CLOSED

I can confirm that. I've opened an issue for the matplotlib repository. blacken-docs worked perfectly on this one.

from hsf-training-ml-webpage.

Thanks for opening your first issue here! If you have any questions, feel free to mention one of the conveners, previous contributors, or attend our weekly meeting (see https://hepsoftwarefoundation.org/workinggroups/training.html). Also, sometimes issues go unnoticed, so don't hesitate to @mention some of us, if we do not come back to you within a few days.

from hsf-training-ml-webpage.

Agreed!

from hsf-training-ml-webpage.

I had a question. Is there a way/package to run some code on the entire episode/lesson, and it automatically updates the python parts and formats them?

from hsf-training-ml-webpage.

Yes, I think https://github.com/asottile/blacken-docs does exactly that (though it might depend a bit on which markdown syntax is being used for the code inclusion).

Feel free to try with that!

from hsf-training-ml-webpage.

Yeah, I'm not sure if it understands the

~~~
import pandas as pd # to store data as dataframe
import numpy as np # for numerical calculations such as histogramming
import matplotlib.pyplot as plt # for plotting
~~~
{: .language-python}

inclusions. Can you confirm that?

from hsf-training-ml-webpage.

Thanks for the answer.

I tried the following test based on your question.

I tried running blacken-doc on the above test snippet which I stored in a .md file.
Nothing happens. No reformatting. It doesn't give any error.

1. If I change the comment position by introducing a , blacken-docs will not re-format.
2. Although it works well if we use the following:

# ~~~
import pandas as pd  # to store data as dataframe
import numpy as np  # for numerical calculations such as histogramming
import matplotlib.pyplot as plt  # for plotting
# ~~~

3. Using black directly on the snippet, re-formats the snippet: here is the black reformatted snippet

import pandas as pd  # to store data as dataframe
import numpy as np  # for numerical calculations such as histogramming
import matplotlib.pyplot as plt  # for plotting

from hsf-training-ml-webpage.

I assume the second thing is then a .py file, right?

Yes, also according to blacken-docs readme the ~~~ doesn't seem to be recognized...

I'll try to fork the project and see if we can easily hack together a version that support this

from hsf-training-ml-webpage.

I've forked blacken-docs: If you install my version (by cloning the repo and then pip install .), blacken-docs will recognize the other syntax as well.

I'll see if I can bring it into the official version...

from hsf-training-ml-webpage.

I've also just tested that and already fixed the issues in this webpage, but I'm sure our other repositories have similar problems...

from hsf-training-ml-webpage.

So if you're interested in this @amanmdesai feel free to apply my modified blacken-docs there :)

Having best-practice formatting is definitely something that we should do!

from hsf-training-ml-webpage.

I've forked blacken-docs: If you install my version (by cloning the repo and then pip install .), blacken-docs will recognize the other syntax as well.

I'll see if I can bring it into the official version...

Forgot to push. Please version as of now :)

from hsf-training-ml-webpage.

See adamchainz/blacken-docs#177

from hsf-training-ml-webpage.

Hi, thanks for the updates.

there seems to be one more issue:

pip install ...

does not seem to work. I see the following error on a different file.

command : blacken-docs 05-mplhep.md
Result 05-mplhep.md:27: code block parse error Cannot parse: 1:4: pip install mplhep

needs more fixing maybe?

from hsf-training-ml-webpage.