Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Kb docstrings #126

Merged
merged 22 commits into from
Nov 1, 2023
Merged

Kb docstrings #126

merged 22 commits into from
Nov 1, 2023

Conversation

miararoy
Copy link
Contributor

Problem

Add docstring to all classes under KB (apart from KB iteslf)

Solution

Write the docstring, avoid the line length check with noqa

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

Test Plan

Pydoclinter will validate docstrings

Copy link
Contributor

@igiloh-pinecone igiloh-pinecone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@miararoy you can use the built-in GH mechanism to commit all suggestions in a single commit

src/canopy/knowledge_base/record_encoder/base.py Outdated Show resolved Hide resolved
src/canopy/knowledge_base/record_encoder/base.py Outdated Show resolved Hide resolved
src/canopy/knowledge_base/record_encoder/base.py Outdated Show resolved Hide resolved
src/canopy/knowledge_base/record_encoder/base.py Outdated Show resolved Hide resolved
src/canopy/knowledge_base/record_encoder/base.py Outdated Show resolved Hide resolved
src/canopy/knowledge_base/record_encoder/dense.py Outdated Show resolved Hide resolved
src/canopy/knowledge_base/record_encoder/dense.py Outdated Show resolved Hide resolved
src/canopy/knowledge_base/record_encoder/openai.py Outdated Show resolved Hide resolved
src/canopy/knowledge_base/record_encoder/dense.py Outdated Show resolved Hide resolved
src/canopy/knowledge_base/reranker/reranker.py Outdated Show resolved Hide resolved
Copy link
Contributor

@igiloh-pinecone igiloh-pinecone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@igiloh-pinecone igiloh-pinecone added this pull request to the merge queue Nov 1, 2023
Merged via the queue into dev with commit 5e3f50c Nov 1, 2023
10 checks passed
@igiloh-pinecone igiloh-pinecone deleted the kb-docstrings branch November 1, 2023 15:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants