Skip to content

DOC: Link to table schema and remove reference to internal API #33791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 29, 2020
Merged

DOC: Link to table schema and remove reference to internal API #33791

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ee053e8
DOC: Link to table schema and remove reference to internal API
bharatr21 Apr 25, 2020
beca45d
DOC: Add flake8 ignore
bharatr21 Apr 26, 2020
14e83d9
DOC: Create RST Link Alias instead of Markdown
bharatr21 Apr 26, 2020
da1b873
DOC: Convert to inline RST
bharatr21 Apr 26, 2020
fbdab8a
Remove trailing whitespace
bharatr21 Apr 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pandas/io/json/_table_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ def build_table_schema(data, index=True, primary_key=None, version=True):

Notes
-----
See `_as_json_table_type` for conversion types.
See [`Table Schema`](https://pandas.pydata.org/docs/user_guide/io.html#table-schema) for conversion types. # noqa: E501
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this will render correctly in rst: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#links-to-external-web-pages

Also to pass flake8 you can just wrap this in the next line like this example:

    To learn more about the frequency strings, please see `this link
    <https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases>`__.

Copy link
Contributor Author

@bharatr21 bharatr21 Apr 26, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad, I thought Markdown was being used. @mroeschke Can you provide an example where link aliases are used?
Like

Get the latest news at `CNN`_.
.. _CNN: http://cnn.com/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you wish to use an alias - see the spinx docs. https://sphinxtechnicalwriting.readthedocs.io/en/latest/sphinx/linking.html

gbq.py for an example.

You can build the documentation locally - https://pandas.pydata.org/pandas-docs/stable/development/contributing.html#how-to-build-the-pandas-documentation to check that it renders as expected. (Feel free to post a screenshot on PRs)

Thanks

Timedeltas as converted to ISO8601 duration format with
9 decimal places after the seconds field for nanosecond precision.

Expand Down