When reviewing #816 I noticed the upper bounds in the comment at the top of field_5x52_impl.h were off by 1 (see fe_verify). This PR fixes the upper bounds and also cleans up the comment along the way.
doc: Fix upper bounds + cleanup in field_5x52_impl.h comment #1030
pull robot-dreams wants to merge 2 commits into bitcoin-core:master from robot-dreams:fe-doc changing 2 files +21 −5-
robot-dreams commented at 5:26 PM on December 3, 2021: contributor
-
real-or-random commented at 4:37 PM on December 6, 2021: contributor
Maybe this is a good opportunity to add a similar comment to the 10x26 implementation (or one that refers to the 5x52 comment).
- robot-dreams force-pushed on Dec 6, 2021
- real-or-random approved
-
real-or-random commented at 9:51 AM on December 22, 2021: contributor
ACK bc7420fcba0c272d23650256e9fea3c12a3abbd3
#816 reminded me that it may be a good idea to document the max magnitudes. (They're checked in the code in
fe_verifybut that's hard to discover if you're not familiar with the code.) But I guess it's not trivial, see #1028 (review) -
real-or-random commented at 11:56 AM on December 22, 2021: contributor
nit: The comment could also mention the order of the limbs.
[0]is the least significant limb though that's the natural choice. -
elichai commented at 12:59 PM on December 22, 2021: contributor
ACK bc7420fcba0c272d23650256e9fea3c12a3abbd3 This is great! I spent a lot of time figuring out what are magnitudes and how the field arithmetic works exactly, so any doc improvements there are very welcome :)
-
doc: Fix upper bounds + cleanup in field_5x52_impl.h comment 58da5bd589
-
doc: Add comment to top of field_10x26_impl.h 1287786c7a
- robot-dreams force-pushed on Dec 22, 2021
-
real-or-random commented at 3:42 PM on December 22, 2021: contributor
ACK 1287786c7a97eff520ffbd6b0d8b2f99dbfc6371
-
real-or-random commented at 5:51 PM on December 22, 2021: contributor
(I cancelled CI because this is blocking the other builds and the diff here is just in comments.)
- real-or-random merged this on Dec 22, 2021
- real-or-random closed this on Dec 22, 2021
- jonasnick cross-referenced this on Jan 2, 2022 from issue Sync Upstream by jonasnick
- real-or-random referenced this in commit 21e2d65b79 on Jan 5, 2022
- dhruv referenced this in commit 6f7e395acc on Jan 26, 2022
- hebasto referenced this in commit 065b6dbf9d on Jan 30, 2022
- dhruv referenced this in commit 139d4b881e on Feb 1, 2022
- fanquake referenced this in commit 8f8631d826 on Mar 17, 2022
- fanquake referenced this in commit 4bb1d7e62a on Mar 17, 2022
- fanquake referenced this in commit 465d05253a on Mar 30, 2022
- stratospher referenced this in commit 4d5afc9767 on Apr 3, 2022
- stratospher referenced this in commit 5b18493cfa on Apr 3, 2022
- fanquake referenced this in commit afb7a6fe06 on Apr 6, 2022
- gwillen referenced this in commit 35d6112a72 on May 25, 2022
- patricklodder referenced this in commit 21badcf9d2 on Jul 25, 2022
- patricklodder referenced this in commit 03002a9013 on Jul 28, 2022
- janus referenced this in commit 3a0652a777 on Aug 4, 2022
- str4d referenced this in commit 522190d5c3 on Apr 21, 2023
- vmta referenced this in commit e1120c94a1 on Jun 4, 2023
- vmta referenced this in commit 8f03457eed on Jul 1, 2023
