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

chore: adds NMT Wrapper specifications #1442

Merged
merged 37 commits into from
Mar 8, 2023
Merged

chore: adds NMT Wrapper specifications #1442

merged 37 commits into from
Mar 8, 2023

Conversation

staheri14
Copy link
Contributor

@staheri14 staheri14 commented Mar 2, 2023

Overview

This PR addresses issue #1296 by adding the specification for the NMT wrapper. The specification is based on the state of implementation after the inclusion of the changes made in pull request #1438.

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

@staheri14 staheri14 self-assigned this Mar 2, 2023
@staheri14 staheri14 added the documentation Improvements or additions to documentation label Mar 2, 2023
@codecov-commenter
Copy link

codecov-commenter commented Mar 2, 2023

Codecov Report

Merging #1442 (802271c) into main (c98c369) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1442   +/-   ##
=======================================
  Coverage   49.19%   49.19%           
=======================================
  Files          79       79           
  Lines        4478     4478           
=======================================
  Hits         2203     2203           
  Misses       2091     2091           
  Partials      184      184           
Impacted Files Coverage Δ
pkg/wrapper/nmt_wrapper.go 77.50% <ø> (ø)

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

@staheri14 staheri14 marked this pull request as ready for review March 3, 2023 19:42
docs/spec/nmt-wrapper.md Outdated Show resolved Hide resolved
@staheri14 staheri14 requested review from rootulp and MSevey March 8, 2023 00:06
@staheri14
Copy link
Contributor Author

I would appreciate it if you could kindly provide any further feedback you may have on the specification. If there are no further comments or changes needed, I plan to merge it tomorrow.

rootulp
rootulp previously approved these changes Mar 8, 2023
Copy link
Collaborator

@rootulp rootulp left a comment

Choose a reason for hiding this comment

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

Great work!

MSevey
MSevey previously approved these changes Mar 8, 2023
Copy link
Member

@MSevey MSevey left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@MSevey MSevey requested a review from a team March 8, 2023 17:37
@staheri14 staheri14 dismissed stale reviews from MSevey and rootulp via 6b342c6 March 8, 2023 18:07
@staheri14 staheri14 merged commit 9266e3f into main Mar 8, 2023
@staheri14 staheri14 deleted the nmt-wrapper-spec branch March 8, 2023 19:47
staheri14 added a commit that referenced this pull request Mar 9, 2023
## Overview
This PR includes a minor modification on the NMT wrapper spec requested
by @liamsi and also previously discussed in
#1442.

This PR briefly mentions that in the extended data square, `Q3` can be
derived from `Q1` or `Q2`, with a pointer to the relevant spec.

## Checklist

- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [x] Linked issues closed with keywords
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.

None yet

5 participants