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

doc: aligns the nmt API doc with the current implementation #215

Merged
merged 4 commits into from
Jun 28, 2023

Conversation

staheri14
Copy link
Contributor

@staheri14 staheri14 commented Jun 27, 2023

Overview

Closes #213

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@codecov
Copy link

codecov bot commented Jun 27, 2023

Codecov Report

Merging #215 (1f97958) into master (9f0f36e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #215   +/-   ##
=======================================
  Coverage   93.67%   93.67%           
=======================================
  Files           5        5           
  Lines         601      601           
=======================================
  Hits          563      563           
  Misses         21       21           
  Partials       17       17           

@staheri14 staheri14 self-assigned this Jun 27, 2023
@staheri14 staheri14 added the documentation Improvements or additions to documentation label Jun 27, 2023
@staheri14 staheri14 marked this pull request as ready for review June 27, 2023 20:57
rootulp
rootulp previously approved these changes Jun 28, 2023
docs/nmt-lib.md Outdated Show resolved Hide resolved
evan-forbes
evan-forbes previously approved these changes Jun 28, 2023
@staheri14 staheri14 dismissed stale reviews from evan-forbes and rootulp via 1e0c14d June 28, 2023 17:48
@staheri14 staheri14 requested review from evan-forbes and rootulp June 28, 2023 17:48
@staheri14 staheri14 merged commit 48b8f96 into master Jun 28, 2023
@staheri14 staheri14 deleted the nmt-api-doc-update branch June 28, 2023 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updating the API docs
3 participants