docs: three README.md claims are contradicted by the shipped code #213
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Found while verifying documentation against source in #163 and #164. All three are in
README.mdand were deliberately left alone by those units as out of their scope.1. Phishing blocklist attribution points at the wrong upstream. The license table cites
AugurProject/eth-phishing-detect, but the runtime fetch URL atsrc/shared/phishingDomains.js:17points at a competitor's org fork of that repo. One of the two is wrong. This also intersects the no-competitor-names policy — resolving it may mean changing the URL rather than the attribution, so establish which upstream is intended before editing either.2. The "no token auto-discovery" guarantee is not what the code does.
src/shared/balances.jsdisplays any ERC-20 with a nonzero balance that is on the bundled list, tracked, or has at least 1,000 holders. Tokens therefore appear without the user adding them. The filtering is plainly deliberate — the code comments say so — so the likely fix is to describe the actual rule. But if the GUARANTEE is what was intended, the code is wrong instead; decide which before writing.3. "Navigation is flat ... No deep nesting, no tabs, no hamburger menus." AddWallet has three tabs and AddressDetail has a
···menu, both deliberate, and the Screen Map now describes a navigation stack. Either soften the paragraph to match the shipped design or treat the UI as the deviation.Implementation requirements
Definition of done
balances.jsbehaviour exactly, or the discrepancy is filed as a code defect.···menu and the stack model.make fmtrun; markdown formatted with the repo's settings.TODO.mdupdated in the same commit.make checkpasses.