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

fix to_signed_felt doc #1262

Closed
wants to merge 3 commits into from
Closed

fix to_signed_felt doc #1262

wants to merge 3 commits into from

Conversation

greged93
Copy link
Contributor

@greged93 greged93 commented Jun 19, 2023

Fix doc tests

Description

The current documentation for to_signed_felt and take_until_unbalanced are incorrect and caused the doc tests to fail.

Checklist

  • Linked to Github Issue
  • Unit tests added
  • Integration tests added.
  • This change requires new documentation.
  • Documentation has been added/updated.
  • CHANGELOG has been updated.

@MegaRedHand
Copy link
Contributor

Could you add an entry to the changelog regarding this change? Something like:

* fix: `take_until_unbalanced` and `to_signed_felt` doctests no longer fail [#1262](https://github.com/lambdaclass/cairo-rs/pull/1262)

@codecov
Copy link

codecov bot commented Jun 26, 2023

Codecov Report

Merging #1262 (7abe5a0) into main (9cef244) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1262   +/-   ##
=======================================
  Coverage   97.60%   97.60%           
=======================================
  Files          89       89           
  Lines       36335    36335           
=======================================
  Hits        35466    35466           
  Misses        869      869           
Impacted Files Coverage Δ
felt/src/lib.rs 90.68% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@Oppen
Copy link
Member

Oppen commented Jun 26, 2023

@MegaRedHand to_signed_felt will be removed after merging the standard felt, right? If that's so, @greged93 would you agree to closing this PR?

@MegaRedHand
Copy link
Contributor

MegaRedHand commented Jun 26, 2023

The function won't be removed in the foreseeable future. We can merge this for now (once we update the changelog).

Context: we are changing the underlying implementation of Felt252 for performance reasons, and some of its API might change. We still need to be able to treat felts as signed for some hints, so we still need this method.

@greged93
Copy link
Contributor Author

Will rebase and update the change log then :)

@greged93
Copy link
Contributor Author

I think the PR can be closed, doctests were fixed by #1281 :)

@greged93 greged93 closed this Jun 27, 2023
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.

None yet

4 participants