Reworded explanation of calculating namespace when IgnoreMaxNamespace is set #134
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rootulp
approved these changes
Mar 14, 2023
Codecov Report
@@ Coverage Diff @@
## master #134 +/- ##
=======================================
Coverage 96.33% 96.33%
=======================================
Files 6 6
Lines 464 464
=======================================
Hits 447 447
Misses 11 11
Partials 6 6
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
staheri14
approved these changes
Mar 14, 2023
evan-forbes
reviewed
Mar 14, 2023
Co-authored-by: Evan Forbes <[email protected]>
evan-forbes
reviewed
Mar 15, 2023
docs/nmt-lib.md
Outdated
|
|
||
| Concretely, for a node `n` with children `l` and `r`, the namespace ID is the largest namespace value from `l` and `r` smaller than `maxPossibleNamespace`, if such a namespace ID exists. | ||
| Otherwise, if all candidate values are equal to `maxPossibleNamespace`, the namespace ID of `n` is set to `maxPossibleNamespace`. | ||
| Precisely, if a set `C = {ns `$\in$` {l.minNs, l.maxNs, r.minNs, r.maxNs}: ns < maxPossibleNamespace}` is not empty, `n.maxNs = max(C)`. If `C` is empty, `n.maxNs = maxPossibleNamespace`. |
There was a problem hiding this comment.
we just need to fix the linter errors, and then we should be able to merge 🙂
docs/nmt-lib.md:53:36 MD038/no-space-in-code Spaces inside code span elements [Context: "` {l.minNs, l.maxNs, r.minNs, ..."]
docs/nmt-lib.md:53:21 MD038/no-space-in-code Spaces inside code span elements [Context: "`C = {ns `"]
evan-forbes
approved these changes
Mar 15, 2023
|
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2023 Celestia Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR rephrases the explanation on how the namespace range is calculated when the parameter
IgnoreMaxNamespaceis set. If merged, it will close #133 .I tried to simplify sentences explaining the logic and add a precise expression at the end of the explanation.
rendered document
Checklist