alteryx / alteryx/woodwork

Improve output of `list_logical_types` and `list_semantic_tags`

未關閉
#1,091 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
documentation
主要語言
Python
星號
155
分支
24
PR 合併指標
30 天內沒有已合併 PR

描述

There are several things we can improve about the outputs to our `list_logical_types` function, which gets used in several places in the Woodwork documentation:
- The descriptions in the `description` takes the typestring of the LogicalType, which get's cut off. We should consider adding a shortened description field to use her. Or, at the very least, the "Represents Logical Types that contain..." section of every docstring can be removed
- `parent_type` might be confusing in that it sounds a bit like there's a class-subclass inheritance structure between logical types that doesn't exist.
- one option might be to change the column to something like `parent_inference_type`
- There are enough columns that you end up having to scroll to see `parent_type`. Maybe we could remove the `type_string` column?

For `list_semantic_tags` the main pain point comes from the `valid_logical_types` column:
- For `numeric` and `category`, there are enough valid logical types that we can't see them all
- We list certain logical types as being valid for being an index, but we do not enforce that anywhere or mention it anywhere else in the docs. Do we want to keep this?

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。