Skip to content

Commit 9a95923

Browse files
authored
Merge pull request #90 from github/kpaulisse-example-more-info
Add note to example configuration that it's not exhaustive
2 parents a677240 + 10cea62 commit 9a95923

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

examples/octocatalog-diff.cfg.rb

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@
1313
#
1414
# To test this configuration file, place it in one of the above locations and run:
1515
# octocatalog-diff --config-test
16+
#
17+
# NOTE: This example file contains some of the more popular configuration options, but is
18+
# not exhaustive of all possible configuration options. Any options that can be declared via the
19+
# command line can also be set via this file. Please consult the options reference for more:
20+
# https://github.com/github/octocatalog-diff/blob/master/doc/optionsref.md
21+
# And reference the source code to see how the underlying settings are constructed:
22+
# https://github.com/github/octocatalog-diff/tree/master/lib/octocatalog-diff/cli/options
1623

1724
module OctocatalogDiff
1825
# Configuration class. See comments for each method to define the most common parameters.

0 commit comments

Comments
 (0)