Closed mDuo13 closed 5 months ago
The Dactyl Style Checker reports a lot of style violations. We should review each of these, and take sensible action on each, which could be:
<-- STYLE_OVERRIDE: will -->
After doing that, we can configure Ripple's Jenkins to run the style checker automatically as a test on new PRs.
The full list (as of 2019-06-14) follows:
Page: XRP Ledger Overview Discouraged word: facilitate (1 instances); suggest 'ease, help' instead. Discouraged word: magnitude (1 instances); suggest 'size' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Discouraged word: simple (2 instances); suggest '(omit)' instead. Page: Introduction to Consensus Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Discouraged word: simply (1 instances); suggest '(omit)' instead. Page: Technical FAQ Discouraged word: therefore (1 instances); suggest 'so' instead. Discouraged word: will (9 instances); suggest '(avoid future tense)' instead. Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Discouraged word: simply (1 instances); suggest '(omit)' instead. Discouraged word: selection (1 instances); suggest 'choice' instead. Discouraged word: expertise (2 instances); suggest 'ability' instead. Discouraged word: utilize (1 instances); suggest 'use' instead. Discouraged phrase: the use of (1 instances); suggest '(omit)' instead. Discouraged word: regarding (1 instances); suggest 'about, of, on' instead. Page: Accounts Discouraged word: purchase (1 instances); suggest 'buy' instead. Page: Cryptographic Keys Discouraged phrase: in the event of (2 instances); suggest 'if' instead. Discouraged word: simply (1 instances); suggest '(omit)' instead. Discouraged word: easy (1 instances); suggest '(omit)' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Discouraged word: easily (1 instances); suggest '(omit)' instead. Page: Deposit Authorization Discouraged phrase: comply with (1 instances); suggest 'follow' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Discouraged word: remainder (1 instances); suggest 'rest' instead. Discouraged word: accordingly (1 instances); suggest 'so' instead. Discouraged phrase: is authorized to (1 instances); suggest 'may' instead. Page: Transaction Basics Discouraged phrase: in the process of (1 instances); suggest '(omit)' instead. Page: Cross-Currency Payments Discouraged word: facilitate (1 instances); suggest 'ease, help' instead. Page: Checks Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Discouraged word: portion (1 instances); suggest 'part' instead. Discouraged phrase: comply with (1 instances); suggest 'follow' instead. Discouraged word: disclose (1 instances); suggest 'show' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Page: Payment Channels Discouraged phrase: time period (1 instances); suggest '(either one)' instead. Page: Issued Currencies Overview Discouraged word: ious (1 instances); suggest 'issuances' instead. Discouraged phrase: comply with (1 instances); suggest 'follow' instead. Page: Trust Lines and Issuing Discouraged word: frequently (1 instances); suggest 'often' instead. Page: Freezing Issued Currencies Discouraged phrase: in order to (1 instances); suggest 'to' instead. Discouraged word: ious (1 instances); suggest 'issuances' instead. Page: Transfer Fees Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Page: Demurrage Discouraged word: reflect (1 instances); suggest 'say, show' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Discouraged word: demonstrate (1 instances); suggest 'prove, show' instead. Page: Consensus Discouraged word: accordingly (2 instances); suggest 'so' instead. Page: Consensus Principles and Rules Discouraged phrase: in addition (1 instances); suggest 'also, besides, too' instead. Page: Consensus Protections Against Attacks and Failure Modes Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Discouraged word: timely (1 instances); suggest 'prompt' instead. Discouraged phrase: in a timely manner (1 instances); suggest 'on time, promptly' instead. Discouraged word: simply (1 instances); suggest '(omit)' instead. Discouraged phrase: a number of (1 instances); suggest 'some' instead. Discouraged word: disclose (1 instances); suggest 'show' instead. Discouraged word: accomplish (2 instances); suggest 'carry out, do' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Page: Transaction Malleability Discouraged word: component (1 instances); suggest 'part' instead. Discouraged word: render (1 instances); suggest 'give, make' instead. Discouraged word: designate (2 instances); suggest 'appoint, choose, name' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Discouraged word: finalize (1 instances); suggest 'complete, finish' instead. Discouraged word: easily (1 instances); suggest '(omit)' instead. Discouraged word: simply (1 instances); suggest '(omit)' instead. Page: Known Amendments Discouraged phrase: comply with (1 instances); suggest 'follow' instead. Discouraged phrase: is authorized to (1 instances); suggest 'may' instead. Discouraged word: therefore (1 instances); suggest 'so' instead. Discouraged word: encounter (2 instances); suggest 'meet' instead. Discouraged word: identical (1 instances); suggest 'same' instead. Page: Ledger History Discouraged word: sufficient (1 instances); suggest 'enough' instead. Discouraged word: portion (1 instances); suggest 'part' instead. Page: Online Deletion Discouraged word: feasible (1 instances); suggest 'can be done, workable' instead. Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged phrase: a number of (4 instances); suggest 'some' instead. Page: History Sharding Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Discouraged word: witnessed (1 instances); suggest 'saw' instead. Discouraged word: sufficient (1 instances); suggest 'enough' instead. Page: Peer Protocol Discouraged word: establish (1 instances); suggest 'set up, create, prove' instead. Page: Transaction Censorship Detection Discouraged word: impacted (1 instances); suggest 'affected, changed' instead. Page: Set Up Secure Signing Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged word: transmit (1 instances); suggest 'send' instead. Page: Look Up Transaction Results Discouraged word: sufficient (1 instances); suggest 'enough' instead. Discouraged word: numerous (1 instances); suggest 'many' instead. Discouraged word: reflect (1 instances); suggest 'say, show' instead. Discouraged word: therefore (1 instances); suggest 'so' instead. Discouraged phrase: in addition (1 instances); suggest 'also, besides, too' instead. Discouraged word: just (1 instances); suggest '(omit)' instead. Page: Monitor Incoming Payments with WebSocket Discouraged word: establish (1 instances); suggest 'set up, create, prove' instead. Discouraged word: expertise (1 instances); suggest 'ability' instead. Discouraged phrase: in addition (1 instances); suggest 'also, besides, too' instead. Page: Send XRP Discouraged word: simple (1 instances); suggest '(omit)' instead. Discouraged word: viable (2 instances); suggest 'practical, workable' instead. Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged word: consult (1 instances); suggest 'see' instead. Page: Reliable Transaction Submission Discouraged word: accomplish (1 instances); suggest 'carry out, do' instead. Page: Assign a Regular Key Pair Discouraged word: subsequent (1 instances); suggest 'later, next' instead. Discouraged word: transmit (3 instances); suggest 'send' instead. Discouraged word: therefore (1 instances); suggest 'so' instead. Page: Change or Remove a Regular Key Pair Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged word: whereas (1 instances); suggest 'because, since' instead. Discouraged word: simply (1 instances); suggest '(omit)' instead. Discouraged word: transmit (1 instances); suggest 'send' instead. Page: Use Checks Discouraged phrase: similar to (1 instances); suggest 'like' instead. Page: Send a Check Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Page: Cash a Check for an Exact Amount Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Page: Cash a Check for a Flexible Amount Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Discouraged word: accordingly (1 instances); suggest 'so' instead. Discouraged word: reflect (1 instances); suggest 'say, show' instead. Page: Cancel a Check Discouraged word: demonstrate (1 instances); suggest 'prove, show' instead. Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Page: List Your Exchange on XRP Charts Discouraged word: frequently (1 instances); suggest 'often' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Discouraged word: just (1 instances); suggest '(omit)' instead. Page: System Requirements Discouraged word: accurate (1 instances); suggest 'correct, exact, right' instead. Page: Build and Run rippled on Ubuntu Discouraged phrase: failed to (1 instances); suggest 'didn't' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Discouraged word: performed (1 instances); suggest 'done' instead. Page: Build and Run rippled on macOS Discouraged word: just (1 instances); suggest '(omit)' instead. Page: Capacity Planning Discouraged phrase: in the near future (1 instances); suggest 'shortly, soon' instead. Discouraged word: utilization (2 instances); suggest 'use' instead. Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged word: encounter (1 instances); suggest 'meet' instead. Discouraged word: therefore (2 instances); suggest 'so' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Discouraged word: reside (1 instances); suggest 'live' instead. Discouraged phrase: in the event of (1 instances); suggest 'if' instead. Discouraged word: substantial (1 instances); suggest 'large, much' instead. Discouraged word: transmit (2 instances); suggest 'send' instead. Page: Run rippled as a Validator Discouraged word: timely (2 instances); suggest 'prompt' instead. Discouraged word: clearly (1 instances); suggest '(omit)' instead. Discouraged word: selection (2 instances); suggest 'choice' instead. Discouraged word: frequently (1 instances); suggest 'often' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Discouraged word: eliminate (1 instances); suggest 'cut, drop, end' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Discouraged word: easy (1 instances); suggest '(omit)' instead. Discouraged word: just (1 instances); suggest '(omit)' instead. Page: Configure Online Deletion Discouraged word: sufficient (1 instances); suggest 'enough' instead. Page: Configure History Sharding Discouraged word: allocate (2 instances); suggest 'divide' instead. Page: Configure Full History Discouraged word: sufficient (2 instances); suggest 'enough' instead. Page: Diagnosing Problems with rippled Discouraged word: remainder (1 instances); suggest 'rest' instead. Discouraged word: just (1 instances); suggest '(omit)' instead. Page: Understanding Log Messages Discouraged word: sufficient (1 instances); suggest 'enough' instead. Discouraged word: frequently (2 instances); suggest 'often' instead. Page: Fix SQLite Transaction Database Page Size Issue Discouraged word: encounter (3 instances); suggest 'meet' instead. Discouraged word: easily (1 instances); suggest '(omit)' instead. Discouraged word: operate (1 instances); suggest 'run, use, work' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Page: Currency Formats Discouraged word: encounter (1 instances); suggest 'meet' instead. Page: Serialization Format Discouraged phrase: in addition (1 instances); suggest 'also, besides, too' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Page: Public rippled Methods Discouraged phrase: is authorized to (1 instances); suggest 'may' instead. Page: ledger Discouraged word: regarding (1 instances); suggest 'about, of, on' instead. Page: deposit_authorized Discouraged phrase: is authorized to (2 instances); suggest 'may' instead. Discouraged word: sufficient (1 instances); suggest 'enough' instead. Page: server_info Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Page: server_state Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Page: wallet_propose Discouraged word: simple (1 instances); suggest '(omit)' instead. Page: can_delete Discouraged word: just (1 instances); suggest '(omit)' instead. Page: validators Discouraged word: will (2 instances); suggest '(avoid future tense)' instead. Page: Check Discouraged phrase: similar to (1 instances); suggest 'like' instead. Page: LedgerHashes Discouraged phrase: in the process of (1 instances); suggest '(omit)' instead. Page: RippleState Discouraged word: frequently (1 instances); suggest 'often' instead. Page: Transaction Common Fields Discouraged word: performed (1 instances); suggest 'done' instead. Page: CheckCash Discouraged phrase: similar to (1 instances); suggest 'like' instead. Page: Transaction Metadata Discouraged word: just (1 instances); suggest '(omit)' instead. Page: rippled Commandline Usage Reference Discouraged word: therefore (1 instances); suggest 'so' instead. Discouraged phrase: in addition (1 instances); suggest 'also, besides, too' instead. Page: Peer Crawler Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged phrase: similar to (3 instances); suggest 'like' instead. Page: RippleAPI Reference Discouraged phrase: in order to (3 instances); suggest 'to' instead. Discouraged word: sufficient (1 instances); suggest 'enough' instead. Discouraged phrase: similar to (3 instances); suggest 'like' instead. Discouraged word: retain (1 instances); suggest 'keep' instead. Discouraged word: facilitate (1 instances); suggest 'ease, help' instead. Discouraged word: will (42 instances); suggest '(avoid future tense)' instead. Discouraged word: proceed (1 instances); suggest 'do, go ahead, try' instead. Discouraged word: wallet (3 instances); suggest 'address, client application, account' instead. Discouraged phrase: hot wallet (3 instances); suggest 'operational address' instead. Discouraged phrase: in order for (2 instances); suggest 'for' instead. Discouraged word: easily (1 instances); suggest '(omit)' instead. Discouraged word: identical (2 instances); suggest 'same' instead. Discouraged word: performed (2 instances); suggest 'done' instead. Discouraged word: just (3 instances); suggest '(omit)' instead. Discouraged phrase: is responsible for (1 instances); suggest '(omit) handles' instead. Discouraged phrase: and/or (3 instances); suggest '__ or __ or both' instead. Discouraged word: regarding (3 instances); suggest 'about, of, on' instead. Discouraged word: subsequently (17 instances); suggest 'after, later, then' instead. Discouraged word: subsequent (1 instances); suggest 'later, next' instead. Page: Ripple Data API v2 Discouraged phrase: time period (19 instances); suggest '(either one)' instead. Discouraged phrase: during the period (1 instances); suggest 'during' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Discouraged word: designate (1 instances); suggest 'appoint, choose, name' instead. Page: xrp-ledger.toml File Discouraged word: operate (2 instances); suggest 'run, use, work' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Discouraged word: will (1 instances); suggest '(avoid future tense)' instead. Discouraged word: consult (1 instances); suggest 'see' instead. Discouraged word: desire (1 instances); suggest 'want, wish' instead. Page: Open a Payment Channel to Enable an Inter-Exchange Network Discouraged word: frequently (1 instances); suggest 'often' instead. Discouraged word: simply (1 instances); suggest '(omit)' instead. Discouraged word: purchase (1 instances); suggest 'buy' instead. Discouraged word: just (1 instances); suggest '(omit)' instead. Discouraged word: wallet (3 instances); suggest 'address, client application, account' instead. Discouraged phrase: hot wallet (2 instances); suggest 'operational address' instead. Discouraged phrase: similar to (1 instances); suggest 'like' instead. Discouraged phrase: cold wallet (1 instances); suggest 'issuing address' instead. Discouraged word: designate (1 instances); suggest 'appoint, choose, name' instead. Discouraged word: viable (1 instances); suggest 'practical, workable' instead. Page: Contribute Code to rippled Discouraged word: simply (1 instances); suggest '(omit)' instead. Discouraged word: disclose (1 instances); suggest 'show' instead. Page: Contribute Code to ripple-lib Discouraged word: simply (1 instances); suggest '(omit)' instead. Discouraged word: disclose (1 instances); suggest 'show' instead. Page: Use an Escrow as a Smart Contract Discouraged word: performed (1 instances); suggest 'done' instead.
The toolchain has been migrated to Redocly and hence this ticket is no longer applicable. https://github.com/XRPLF/xrpl-dev-portal/issues/2454 tracks adding a style checker to the Redocly-based site.
The Dactyl Style Checker reports a lot of style violations. We should review each of these, and take sensible action on each, which could be:
<-- STYLE_OVERRIDE: will -->
)After doing that, we can configure Ripple's Jenkins to run the style checker automatically as a test on new PRs.
The full list (as of 2019-06-14) follows: