fix(datasets): fix SparkStreamingDataSet docstring
#236
Conversation
|
This contains commits from gh-234, can be rebased |
| @@ -20,15 +20,16 @@ class SparkStreamingDataSet(AbstractDataSet): | |||
| `YAML API <https://kedro.readthedocs.io/en/stable/data/\ | |||
| data_catalog.html#use-the-data-catalog-with-the-yaml-api>`_: | |||
| .. code-block:: yaml | |||
|
|
|||
There was a problem hiding this comment.
Looks good, did you test it locally? Maybe open a PR on the framework side cherry picking this commit kedro-org/kedro@9c08611
AhdraMeraliQB
changed the title
Signed-off-by: Nok Chan <[email protected]>
deepyaman
changed the title
SparkStreamingDataSet docstring
There was a problem hiding this comment.
Nice! I was looking at this yesterday; this seems to cover the two comments Ivan had left on the original PR that weren't addressed. :)
I actually had one more question on this, and maybe you can roll it into the same PR--does it make sense for the "Spark Streaming" docs to be in spark/README.md? It only applies to a single dataset implementation, so it's a bit confusing.
But approving in case not sure how to best handle that/want to do it later.
|
@deepyaman Frankly I don't know what's the README.md for, it's not a standard and only exists for very few datasets. I don't believe it will be render in the Kedro's doc either so I would say it's not very important at all. |
Signed-off-by: Nok Chan <[email protected]>
|
This is still failing - I try to fix the build but it starts complaining the |
Until we significantly rework how our docs are built, we don't have a way to place narrative/prose documentation from this repo on docs.kedro.org (see kedro-org/kedro#2072 (comment)) |
Signed-off-by: Ahdra Merali <[email protected]>
|
I created this PR in |
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
… into fix/setup-pickle
* fix malform docstring in SparkStreamingDataSet Signed-off-by: Nok Chan <[email protected]> * change indent Signed-off-by: Nok Chan <[email protected]> * Test without docstring Signed-off-by: Ahdra Merali <[email protected]> * Add back docstring Signed-off-by: Ahdra Merali <[email protected]> * Format docstring Signed-off-by: Ahdra Merali <[email protected]> * Fix typo Signed-off-by: Ahdra Merali <[email protected]> * Fix typo * Lint Signed-off-by: Ahdra Merali <[email protected]> --------- Signed-off-by: Nok Chan <[email protected]> Signed-off-by: Ahdra Merali <[email protected]> Co-authored-by: Ahdra Merali <[email protected]> Co-authored-by: Ahdra Merali <[email protected]> Signed-off-by: Afaque Ahmad <[email protected]>
* fix malform docstring in SparkStreamingDataSet Signed-off-by: Nok Chan <[email protected]> * change indent Signed-off-by: Nok Chan <[email protected]> * Test without docstring Signed-off-by: Ahdra Merali <[email protected]> * Add back docstring Signed-off-by: Ahdra Merali <[email protected]> * Format docstring Signed-off-by: Ahdra Merali <[email protected]> * Fix typo Signed-off-by: Ahdra Merali <[email protected]> * Fix typo * Lint Signed-off-by: Ahdra Merali <[email protected]> --------- Signed-off-by: Nok Chan <[email protected]> Signed-off-by: Ahdra Merali <[email protected]> Co-authored-by: Ahdra Merali <[email protected]> Co-authored-by: Ahdra Merali <[email protected]> Signed-off-by: Afaque Ahmad <[email protected]>
Description
Development notes
Checklist
RELEASE.mdfile