Skip to content

Conversation

@tomtana
Copy link
Owner

@tomtana tomtana commented Oct 11, 2025

  • replace Chinese api description with English translation
  • add ruff and pre-commit hooks
  • update documentation
  • update pandoc filter to translate notes, warnings, etc to github alerts

Copilot AI review requested due to automatic review settings October 11, 2025 13:04
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refactors the README generation workflow and improves GlInet class documentation by removing outdated parameter documentation and enhancing the CI workflow.

  • Removes obsolete parameter documentation from three methods in the GlInet class
  • Updates GitHub Actions workflow to trigger on pull requests and improve commit logic
  • Enhances the workflow's conditional commit behavior to only commit when changes exist

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
pyglinet/glinet.py Removes outdated parameter documentation from __init__, __load_api_description, and get_api_client methods
.github/workflows/generate_readme.yml Adds pull request trigger and improves conditional commit logic with proper git diff checking

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@codecov-commenter
Copy link

codecov-commenter commented Oct 11, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 96.66667% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.77%. Comparing base (96cb1d1) to head (55369ac).

Files with missing lines Patch % Lines
pyglinet/glinet.py 95.23% 2 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files
@@           Coverage Diff           @@
##             main      #16   +/-   ##
=======================================
  Coverage   95.77%   95.77%           
=======================================
  Files           6        6           
  Lines         379      379           
=======================================
  Hits          363      363           
  Misses         16       16           
Flag Coverage Δ
unittests 95.77% <96.66%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tomtana added 26 commits October 11, 2025 15:08
…uction, features, installation instructions, and API usage sections.
@tomtana tomtana force-pushed the feature/add_english_api_fix_docu branch from 935d50c to 8d3df74 Compare October 11, 2025 21:04
@tomtana tomtana merged commit 81ec520 into main Oct 11, 2025
21 checks passed
@tomtana tomtana deleted the feature/add_english_api_fix_docu branch October 11, 2025 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants