deepchecks icon indicating copy to clipboard operation
deepchecks copied to clipboard

[DEE-183] [FEAT] documentation links resolver

Open yromanyshyn opened this issue 2 years ago • 0 comments

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). 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

yromanyshyn avatar Aug 16 '22 14:08 yromanyshyn