Skip to content

Commit

Permalink
chore(deps): Bump myst-parser from 0.18.1 to 0.19.0 (#1469)
Browse files Browse the repository at this point in the history
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Edgar Ramírez Mondragón <edgar@meltano.com>
  • Loading branch information
dependabot[bot] and edgarrmondragon authored Mar 1, 2023
1 parent eab5d44 commit 10ff04f
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,4 +217,4 @@ All public modules in the SDK are checked for the presence of docstrings in clas
### What is Poetry and why do we need it?

For more info on `Poetry` and `Pipx`, please see the topic in our
[python tips](../python_tips.md) guide.
[python tips](./python_tips.md) guide.
3 changes: 1 addition & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,7 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

# TODO: set this back to 3 after MyST-Parser 0.21.0 is released
myst_heading_anchors = 4
myst_heading_anchors = 3

redirects = {
"porting.html": "guides/porting.html",
Expand Down
2 changes: 1 addition & 1 deletion docs/deprecation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ incompatible way, following their deprecation, as indicated in the
as part of the stream pagination process. It is replaced by the
[`RESTStream.get_new_paginator`](singer_sdk.RESTStream.get_new_paginator).

See the [migration guide](../guides/pagination-classes.md) for more information.
See the [migration guide](./guides/pagination-classes.md) for more information.
2 changes: 1 addition & 1 deletion docs/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Some APIs instead return the records as values inside an object where each key i

### Detailed Class Reference

For a detailed reference, please see the [SDK Reference Guide](./reference.md)
For a detailed reference, please see the [SDK Reference Guide](./reference.rst)

### Implementation Details

Expand Down
8 changes: 4 additions & 4 deletions docs/guides/porting.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ When porting over an existing tap, most developers find it easier to start from
1. Within your existing repo, create a new branch.
1. Move _all_ of the files in the old branch into a subfolder called "archive".
1. Commit and push the result to your new branch. (You'll do this several times along the way, which creates a fresh tree and a fresh diff for subsequent commits.)
1. Now follow the steps in the [dev guide](dev_guide.md#building-a-new-tap-or-target) to create a new project using the Tap cookiecutter.
1. Now follow the steps in the [dev guide](../dev_guide.md#building-a-new-tap-or-target) to create a new project using the Tap cookiecutter.
1. Copy all the files from the cookiecutter output into your main repo and commit the result.

## Settings and Readme
Expand Down Expand Up @@ -103,7 +103,7 @@ _Important: If you've gotten this far, this is a good time to commit your code b

Pagination is generally unique for almost every API. There's no single method that solves for very different API's approach to pagination.

Most likely you will use [get_new_paginator](singer_sdk.RESTStream.get_new_paginator) to instantiate a [pagination class](./../../classes/singer_sdk.pagination.BaseAPIPaginator.rst) for your source, and you'll use `get_url_params` to define how to pass the "next page" token back to the API when asking for subsequent pages.
Most likely you will use [get_new_paginator](singer_sdk.RESTStream.get_new_paginator) to instantiate a [pagination class](./../classes/singer_sdk.pagination.BaseAPIPaginator.rst) for your source, and you'll use `get_url_params` to define how to pass the "next page" token back to the API when asking for subsequent pages.

When you think you have it right, run `poetry run tap-mysource` again, and debug until you are confident the result is including multiple pages back from the API.

Expand Down Expand Up @@ -197,7 +197,7 @@ Notes:

- As should be expected, you are free to subclass streams in order to have their behavior be inherited from other stream classes.
- For instance, if 3 streams use one pagination method, and 5 other streams use a different method, you can have each stream created as a subclass of a stream that has desired behavior.
- If you have streams which invoke each other in a nested layout, please refer to the `parent_stream_class` property and its [related documentation](../../stream_maps.md).
- If you have streams which invoke each other in a nested layout, please refer to the `parent_stream_class` property and its [related documentation](../stream_maps.md).
- As before, if you do not already have a full JSON Schema file for each stream type, it is generally a good practice to start with just 5-8 properties per stream. You don't have to define all properties up front and before doing so, it is generally more valuable to test that each stream is getting data.

## Run pytest again, add stream properties, and repeat
Expand All @@ -218,7 +218,7 @@ poetry run pytest

The SDK will automatically handle `STATE` for you 99% of the time. However, it is very likely that the legacy version of the tap has a different `STATE` format in comparison with the SDK format. If you want to seamlessly support both old and new STATE formats, you'll need to define a conversion operation.

To handle the conversion operation, you'll override [`Tap.load_state()`](singer_sdk.Tap.load_state). The exact process of converting state is outside of this guide, but please check the [STATE implementation docs](../../implementation/state.md) for an explanation of general format expectations.
To handle the conversion operation, you'll override [`Tap.load_state()`](singer_sdk.Tap.load_state). The exact process of converting state is outside of this guide, but please check the [STATE implementation docs](../implementation/state.md) for an explanation of general format expectations.

### Leverage Auto Generated README

Expand Down
29 changes: 15 additions & 14 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ PyYAML = "^6.0"
sphinx = {version = ">=4.5,<6.0", optional = true}
furo = {version = "^2022.12.7", optional = true}
sphinx-copybutton = {version = ">=0.3.1,<0.6.0", optional = true}
myst-parser = {version = ">=0.17.2,<0.19.0", optional = true}
myst-parser = {version = ">=0.17.2,<0.20.0", optional = true}
sphinx-autobuild = {version = "^2021.3.14", optional = true}
sphinx-reredirects = {version = "^0.1.1", optional = true}

Expand Down

0 comments on commit 10ff04f

Please sign in to comment.