kedro icon indicating copy to clipboard operation
kedro copied to clipboard

Documentation review to improve styling

Open yetudada opened this issue 2 years ago • 2 comments

Description

This task summarises an exercise to review the documentation for stying improvements. Some of this work will also aim to de-gerund the documentation.

Possible Implementation

Use the style guide to help inform the changes.

yetudada avatar Jun 30 '22 10:06 yetudada

Will add comments as I see issues arise.

CarolineMLynch avatar Jun 30 '22 10:06 CarolineMLynch

Note: the gerund form of a verb is the "-ing" form.. e.g. examples on https://kedro.readthedocs.io/en/stable/get_started/prerequisites.html#virtual-environments. In general, other forms of the verb should be used. However, there will be cases where it is better left as a gerund.

CarolineMLynch avatar Jul 01 '22 14:07 CarolineMLynch

This is a somewhat nebulous issue! Can I suggest that we close it an instead create a set of issues (or one big one) as I audit the docs, rather than this one, which is serving more as the audit task itself. (cc @NeroOkwa @yetudada)

stichbury avatar Oct 17 '22 10:10 stichbury