Skip to content
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.

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

Review and update current Jobbergate's documentation #613

Merged
merged 1 commit into from
Sep 27, 2024

Conversation

fschuch
Copy link
Member

@fschuch fschuch commented Sep 6, 2024

What

  • Migrated docstrings from sphinx to google style
  • Renamed function garbage_collect to garbage_collector on the API, for clarification
  • Fixed spelling errors in the docstrings

Why

Address feedback from acceptance testes

Task: https://jira.scania.com/browse/ASP-3778


Peer Review

Please follow the upstream omnivector documentation concerning
peer-review guidelines.

migrated docstrings from sphinx to google style

renamed function garbage_collect to garbage_collector

Fixed spelling errors in the docstrings
Copy link

codecov bot commented Sep 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.17%. Comparing base (e106ab9) to head (34206c0).
Report is 16 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #613   +/-   ##
=======================================
  Coverage   92.17%   92.17%           
=======================================
  Files          83       83           
  Lines        4423     4424    +1     
=======================================
+ Hits         4077     4078    +1     
  Misses        346      346           
Flag Coverage Δ
agent 93.48% <ø> (ø)
api 95.09% <ø> (ø)
cli 87.70% <ø> (+<0.01%) ⬆️
core 96.32% <ø> (ø)

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.

@fschuch fschuch merged commit d89a13e into main Sep 27, 2024
12 checks passed
@fschuch fschuch deleted the fschuch/ASP-3778-address-feedback-on-acceptance branch September 27, 2024 19:54
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.

2 participants