deepchecks / deepchecks/deepchecks

[DEE-183] [FEAT] documentation links resolver

Open
#1,913 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
4.1k
Forks
303
PR merge metrics
No merged PRs in 30d

Description

Recently we added a small function to resolve a reference link to the documentation section/page - `deepchecks.utils.docref.doclink` (was added by this [PR](https://github.com/deepchecks/deepchecks/pull/1885)). An obligation of this function is to return a documentation link for that specific installed deepchecks package version. It uses a dictionary to store links per version but currently that dictionary is mostly empty/

NOTE:
`deepchecks.utils.docref.doclink` is used to resolve links that we show in the output that users see

so, generally, the next things should be done:
1. go though the project and find places with references to the documentation (beyound docstrings) and replace them with `doclink` function
2. fill `links` dictionary within `deepchecks.utils.docref` module

@noamzbr do you have any other additional comments?

[DEE-183](https://linear.app/deepchecks/issue/DEE-183/[feat]-documentation-links-resolver)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.