Link to the appropriate "schema wrapper" objects in the API docs
See original GitHub issueMost of the API docs make numerous references to schema wrapper objects, for example altair.Chart.configure_axisX()
, but don’t actually explain the method options or link to the appropriate wrapper object. This makes it incredibly difficult to navigate the docs without constantly using the search or having the Vega schema open in another tab. For example configure_axisX
should link to altair.AxisConfig
. Fixing this would make the API docs a lot more user friendly.
Please follow these steps to make it more efficient to respond to your feature request.
- Since Altair is a Python wrapper around the Vega-Lite visualization grammar, most feature requests should be reported directly to Vega-Lite. You can click the Action Button of your Altair chart and “Open in Vega Editor” to create a reproducible Vega-Lite example.
- Search for duplicate issues.
- Describe the feature’s goal, motivating use cases, and its expected behavior.
Issue Analytics
- State:
- Created a year ago
- Comments:6
Top Results From Across the Web
Step 5: The components object (OpenAPI tutorial)
The components object is unique from the other objects in the OpenAPI specification. In components , you store re-usable definitions that ...
Read more >Structuring a complex schema — Understanding JSON ...
In order to reference a schema, we need a way to identify a schema. ... In this documentation, we will refer to schemas...
Read more >Using the API | Google API Discovery Service
Resource and schema details describing the API's data. ... Consult the Reference documentation for more details about each property.
Read more >OpenAPI Specification v3.0.3 | Introduction, Definitions, & More
The default value is false . schema, Schema Object | Reference Object, The schema defining the type used for the parameter. example, Any ......
Read more >REST Resource: tables | BigQuery - Google Cloud
When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats:...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
You’re right, I mixed up which files are autogenerated. It is only the files within the
schema
directory that are autogenerated. Theapi.py
file is not (as mentioned in the maintainer notes), so you should be able to make your changes there directly.Hi @joelostblom. I’ve had a go patching the docstrings in #2610. However this only fixes the
configure_X
functions. For things likeaggregate_X
, I’d like to do the same, but it seems likealtair/vegalite/v5/api.py
might be autogenerated, so if I edit the docstring fordef transform_aggregate
, it might not be the right place. If so, where is this generated from? I can’t work it out.