Module: Docscribe::CLI::UpdateTypes

Defined in:
lib/docscribe/cli/update_types.rb

Overview

Two-pass update: rebuild docs then re-merge with RBS types.

Usage:

docscribe update_types [directory]

Pass 1: ‘-AkB –rbs-collection <dir>` — aggressive rebuild, keep descriptions,

no boilerplate, using RBS collection signatures.

Pass 2: ‘-aB –rbs-collection <dir>` — safe merge cleanup, no boilerplate,

using RBS collection signatures.

Constant Summary collapse 

<<~TEXT
  Usage: docscribe update_types [directory]

  Two-pass type-aware documentation update.

  Pass 1 (aggressive):  docscribe -AkB --rbs-collection <dir>
    rebuild doc blocks, keep descriptions, no boilerplate

  Pass 2 (safe):        docscribe -aB --rbs-collection <dir>
    safe merge cleanup, no boilerplate

TEXT

Class Method Summary collapse

Class Method Details

.run(argv) ⇒ Integer

Parameters:

  • argv (Array<String>)

Returns:

  • (Integer) 


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/docscribe/cli/update_types.rb', line 36

def run(argv)
  options = parse_options(argv)
  dir = options[:dir]

  announce_start

  exit1 = run_first_pass(dir)
  return exit1 unless exit1.zero?

  exit2 = run_second_pass(dir)
  return exit2 unless exit2.zero?

  announce_complete
  0
end