Skip to content

Commit

Permalink
Add titles to YARD files!
Browse files Browse the repository at this point in the history
  • Loading branch information
kspurgin committed Sep 13, 2023
1 parent 9f415bc commit 1cf40b7
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 9 deletions.
20 changes: 12 additions & 8 deletions doc/cli.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
<!--
# @markup markdown
# @title Command line interface (CLI)/thor
-->

# Command line interface (CLI) for running jobs/tasks

`kiba-extend` uses [Thor](http://whatisthor.com/) to provide a command line interface for working with your ETL project.
`kiba-extend` uses [Thor](http://whatisthor.com/) to provide a command line interface for working with your ETL project.

I chose Thor over Rake because it is awkward to pass options/parameters in Rake, and because automated testing of Rake tasks is convoluted. ([ref](https://technology.doximity.com/articles/move-over-rake-thor-is-the-new-king))

## Help on the CLI

The following command will list all available tasks.
The following command will list all available tasks.

`thor -T`

This lets you search for only tasks beginning with "reg":

`thor list reg`

Some of the task descriptions may be truncated in the display, though. This also doesn't tell you what parameters/options you can pass in.
Some of the task descriptions may be truncated in the display, though. This also doesn't tell you what parameters/options you can pass in.

To get more details on a given task:
To get more details on a given task:

`thor --help TASKNAME`

Expand All @@ -26,7 +31,7 @@ For example: `thor --help reg:list` or `thor --help jobs:tagged`

#### Plain parameters

When you see:
When you see:

```
Usage:
Expand All @@ -39,7 +44,7 @@ The all caps word is a placeholder for a parameter that gets passed in without a

#### Boolean options

Boolean options are presented a bit oddly in the help. For example:
Boolean options are presented a bit oddly in the help. For example:

```
Options:
Expand Down Expand Up @@ -85,7 +90,7 @@ Usage:

In this case, replace the all-caps word with one of the possible values (if listed), or your uncontrolled string.

To use the full option name:
To use the full option name:

`thor jobs:tagged cspace --run --verbosity=verbose`

Expand All @@ -100,4 +105,3 @@ Thor tasks are defined in `kiba-extend/lib/tasks`.
There is a Thorfile in the `kiba-extend` base directory that autoloads those tasks and runs the CLI when you type thor commands. (How this works is some kinda ruby/thor library magic I haven't dug into fully).

Your ETL project base directory (if following the repo template/FWM example), will also have a Thorfile in its base directory, which will call in all of `kiba-extend`'s tasks, as well as any you create in your own repo's `/lib/tasks` directory.

5 changes: 5 additions & 0 deletions doc/common_patterns_tips_tricks.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
# @markup markdown
# @title Common patterns, tips, and tricks
-->

# Common patterns, tips, and tricks

## Troubleshooting `MissingDependencyError` when all dependencies are set up as expected
Expand Down
5 changes: 5 additions & 0 deletions doc/contributing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
# @markup markdown
# @title Contributing to kiba-extend
-->

# Contributing to `kiba-extend`

The preferred code, documentation, and testing practices have evolved over time and have not all been retrospectively updated throughout the codebase.
Expand Down
5 changes: 5 additions & 0 deletions doc/cookbook.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
# @markup markdown
# @title Cookbook
-->

# kiba-extend cookbook

A place to share patterns for handling common workflows.
Expand Down
5 changes: 5 additions & 0 deletions doc/file_registry_entry.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
# @markup markdown
# @title File Registry Entry Reference
-->

# File Registry Entry Reference

## What are file registry entries?
Expand Down
9 changes: 8 additions & 1 deletion doc/iterative_cleanup.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Using the `IterativeCleanup` mixin (added in v4.0.0)
<!--
# @markup markdown
# @title Using the IterativeCleanup mixin
-->

# Using the `IterativeCleanup` mixin

"Iterative cleanup" means the client may provide the worksheet more
than once, or that you may need to produce a fresh worksheet for the
Expand All @@ -8,6 +13,8 @@ There is no reason you can't use the pattern for expected one-round
cleanup. How often does one round of cleanup turn into more, after
all?

`IterativeCleanup` was added in added in v4.0.0.

## Examples

[kiba-extend-project](https://github.com/lyrasis/kiba-extend-project)
Expand Down

0 comments on commit 1cf40b7

Please sign in to comment.