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

Add API example program #539

Merged
merged 2 commits into from
Nov 12, 2024
Merged

Add API example program #539

merged 2 commits into from
Nov 12, 2024

Conversation

pmachapman
Copy link
Collaborator

@pmachapman pmachapman commented Nov 10, 2024

This PR adds an API example program to the samples directory showing how to create a translation engine, and generate a pre-translation.

Please let me know if you want any further work done to it, or any further documentation.

The USFM files in the two directories are entirely my own work (i.e. no copyright issues).


This change is Reviewable

@codecov-commenter
Copy link

codecov-commenter commented Nov 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.25%. Comparing base (a68bc9c) to head (cb00855).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #539   +/-   ##
=======================================
  Coverage   57.25%   57.25%           
=======================================
  Files         299      299           
  Lines       15664    15664           
  Branches     2163     2163           
=======================================
  Hits         8968     8968           
  Misses       6054     6054           
  Partials      642      642           

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

Copy link
Contributor

@ddaspit ddaspit left a comment

Choose a reason for hiding this comment

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

Reviewed 8 of 8 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @pmachapman)


samples/ApiExample/data/TEA.zip line 0 at r1 (raw file):
I would prefer not to check in binary files. Could you check in the project files directly, and then add code to zip up the files?

Copy link
Collaborator Author

@pmachapman pmachapman left a comment

Choose a reason for hiding this comment

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

Reviewable status: 4 of 27 files reviewed, 1 unresolved discussion (waiting on @ddaspit)


samples/ApiExample/data/TEA.zip line at r1 (raw file):

Previously, ddaspit (Damien Daspit) wrote…

I would prefer not to check in binary files. Could you check in the project files directly, and then add code to zip up the files?

Done.

Copy link
Contributor

@ddaspit ddaspit left a comment

Choose a reason for hiding this comment

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

Excellent contribution. Thank you.

Reviewed 23 of 23 files at r2, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @pmachapman)

@pmachapman pmachapman merged commit 594a92c into main Nov 12, 2024
3 checks passed
@pmachapman pmachapman deleted the api_example_code branch November 12, 2024 18:15
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