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

Naming fixes #71

Merged
merged 3 commits into from
Sep 15, 2021
Merged

Naming fixes #71

merged 3 commits into from
Sep 15, 2021

Conversation

fjarri
Copy link
Collaborator

@fjarri fjarri commented Sep 15, 2021

Fixes #33

  • renames SecretKeyFactory::secret_key_by_label()/secret_factory_by_label() -> make_key()/make_factory(). The former names were way too wordy.
  • replaces remaining (from Rename "num_kfrags" to "shares" #69) instances of m/n with threshold/shares.
  • replaces verifying_key parameter in Signature::verify() with verifying_pk - it is called like that everywhere else.

@fjarri fjarri added documentation Improvements or additions to documentation API Related to public API labels Sep 15, 2021
@fjarri fjarri added this to the v1.0.0 milestone Sep 15, 2021
@codecov-commenter
Copy link

codecov-commenter commented Sep 15, 2021

Codecov Report

Merging #71 (d9327f3) into master (c0e03ef) will not change coverage.
The diff coverage is 85.71%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #71   +/-   ##
=======================================
  Coverage   82.36%   82.36%           
=======================================
  Files          14       14           
  Lines        1083     1083           
=======================================
  Hits          892      892           
  Misses        191      191           
Impacted Files Coverage Δ
umbral-pre/src/keys.rs 71.25% <85.71%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c0e03ef...d9327f3. Read the comment docs.

@fjarri fjarri merged commit 00b9d26 into nucypher:master Sep 15, 2021
@fjarri fjarri deleted the naming-fixes branch September 15, 2021 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Related to public API documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Synchronize wording and argument names in docs and examples
2 participants