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

Documentation using Yard #32

Merged
merged 2 commits into from
Nov 2, 2022
Merged

Conversation

sabarish98
Copy link
Contributor

@sabarish98 sabarish98 commented Nov 1, 2022

  • Covered 4 APIs - Bundles, Projects, Storage and Source Files. Added request params, API doc info
  • Corresponding Gemfile and Workflow file changes
  • Removed div from Readme as documentation generated caused issues while rendering badges markdown within div

Addresses issue #23

@sabarish98 sabarish98 mentioned this pull request Nov 1, 2022
5 tasks
@codecov
Copy link

codecov bot commented Nov 2, 2022

Codecov Report

Merging #32 (fadff5c) into main (76a5d55) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #32   +/-   ##
=======================================
  Coverage   97.88%   97.88%           
=======================================
  Files          57       57           
  Lines        2586     2586           
=======================================
  Hits         2531     2531           
  Misses         55       55           
Impacted Files Coverage Δ
lib/crowdin-api/api_resources/bundles.rb 100.00% <ø> (ø)
lib/crowdin-api/api_resources/projects.rb 100.00% <ø> (ø)
lib/crowdin-api/api_resources/source_files.rb 100.00% <ø> (ø)
lib/crowdin-api/api_resources/storages.rb 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@andrii-bodnar andrii-bodnar merged commit 8acf462 into crowdin:main Nov 2, 2022
@andrii-bodnar
Copy link
Member

@sabarish98 thanks a lot for your contribution!

I just made some improvements (#33) to the workflow, deployed, and now it's available - crowdin.github.io/crowdin-api-client-ruby 🎉

@andrii-bodnar andrii-bodnar linked an issue Nov 2, 2022 that may be closed by this pull request
5 tasks
@andrii-bodnar andrii-bodnar mentioned this pull request Nov 2, 2022
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto generated docs
2 participants