search

kedro-org / kedro-plugins

First-party plugins maintained by the Kedro team.
Apache License 2.0
92 stars 89 forks source link

docs(datasets): blacken code in rst literal blocks #365

Closed deepyaman closed 1 year ago

deepyaman commented 1 year ago

Description

Basically, auto-format the code in docstrings.

Context

Because it bothers me, because I'm me. Also, helps catch silly issues for https://github.com/kedro-org/kedro/issues/2287 (since at least it validates the AST).

Possible Implementation

kedro-org/kedro-plugins#362 (currently for one dateset, but it just needs to be extended by marking the rest of these as explicit pycon blocks)

Possible Alternatives

astrojuanlu commented 1 year ago

If this is for kedro-datasets, should we transfer this issue?

deepyaman commented 1 year ago

If this is for kedro-datasets, should we transfer this issue?

I added it here, so it can be added to the sprint board (needs to be in the main repo for that, right?).

If not, both this and kedro-org/kedro-plugins#366 can be in kedro-plugins, yes.

stichbury commented 1 year ago

If this is for kedro-datasets, should we transfer this issue?

I added it here, so it can be added to the sprint board (needs to be in the main repo for that, right?).

You can have something in a different repo and put it in the project (right hand sidebar) so it appears on the board. So I've moved this and https://github.com/kedro-org/kedro-plugins/issues/366