Skip to content

SNOW-3031353: Documentation: describe extras #4063

@tvoipio

Description

@tvoipio

What is the current behavior?

Documentation of the Python package (especially README.md) does not list or describe the extras available for installation, except pandas and modin. E.g. secure-local-storage needs to be dug from setup.py or from very deep in the Snowflake product documentation.

No open issues were found in the tracker using query is:issue state:open extras.

What is the desired behavior?

README.md lists available extras and the behavior their installation enables, at least with references to other Snowflake documentation.

How would this improve snowflake-snowpark-python?

This would make information faster to find, hence make the package easier to use. Some behavior, e.g. credential caching enabled by secure-local-storage, is not easy to discover from product documentation, so making it visible here would make the behavior easier to discover.

References, Other Background

N/A

Metadata

Metadata

Labels

featureNew feature or requeststatus-triage_doneInitial triage done, will be further handled by the driver team

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions