Skip to content

[GSK-2021] Parse docstrings for hub #1646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 17 commits into from
Dec 4, 2023
Merged

[GSK-2021] Parse docstrings for hub #1646

merged 17 commits into from
Dec 4, 2023

Conversation

@Hartorn
Copy link
Member

@Hartorn Hartorn commented Nov 29, 2023 •
edited
Loading

Description

See also https://github.com/Giskard-AI/giskard-hub/pull/261

Related Issue

Type of Change

  • 📚 Examples / docs / tutorials / dependencies update
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🔐 Security fix

Checklist

  • I've read the CODE_OF_CONDUCT.md document.
  • I've read the CONTRIBUTING.md guide.
  • I've updated the code style using make codestyle.
  • I've written tests for all new methods and classes that I created.
  • I've written the docstring in Google format for all the methods and classes that I used.
@linear
Copy link

linear bot commented Nov 29, 2023

GSK-2021 Parse docstrings for Hub

Check core.core.CallableMeta.extract_doc
@Hartorn Hartorn requested review from Googleton and andreybavt and removed request for Googleton November 29, 2023 12:20
@Hartorn Hartorn self-assigned this Nov 29, 2023
@Hartorn Hartorn marked this pull request as ready for review November 29, 2023 12:20
@Hartorn Hartorn mentioned this pull request Nov 29, 2023
Closed
andreybavt
andreybavt reviewed Nov 30, 2023
View reviewed changes
giskard/core/core.py Outdated
return code

@staticmethod
def extract_doc(func):
Copy link
Contributor

@andreybavt andreybavt Nov 30, 2023

Choose a reason for hiding this comment

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

@Hartorn , could you add unit tests please?
andreybavt
andreybavt reviewed Nov 30, 2023
View reviewed changes
Copy link
Contributor

@andreybavt andreybavt left a comment

Choose a reason for hiding this comment

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

The PR looks good, just tests to be added
@andreybavt andreybavt added the Lockfile Temporary label to update pdm.lock label Dec 2, 2023
@github-actions github-actions bot removed the Lockfile Temporary label to update pdm.lock label Dec 3, 2023
@sonarqubecloud
Copy link

sonarqubecloud bot commented Dec 4, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

93.9% 93.9% Coverage
0.0% 0.0% Duplication
@Hartorn Hartorn changed the title Feature/gsk 2021 parse docstrings for hub Dec 4, 2023
@Hartorn Hartorn merged commit ce7048d into main Dec 4, 2023
@Hartorn Hartorn deleted the feature/gsk-2021-parse-docstrings-for-hub branch December 4, 2023 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants

@Hartorn @andreybavt @mattbit