Module: DocGuard

Defined in:
lib/doc_guard.rb,
lib/doc_guard/cli.rb,
lib/doc_guard/config.rb,
lib/doc_guard/version.rb,
lib/doc_guard/assess_documentation_relevance/process.rb,
lib/doc_guard/record_documentation_relevance/process.rb,
lib/doc_guard/shared/subprocesses/calculate_current_digests.rb,
lib/doc_guard/shared/subprocesses/load_tracked_files_from_documentation.rb,
lib/doc_guard/record_documentation_relevance/subprocesses/record_digests.rb,
lib/doc_guard/assess_documentation_relevance/subprocesses/compare_digests.rb,
lib/doc_guard/assess_documentation_relevance/subprocesses/assess_relevance.rb,
lib/doc_guard/record_documentation_relevance/subprocesses/report_recording.rb,
lib/doc_guard/assess_documentation_relevance/subprocesses/report_assessment.rb,
lib/doc_guard/assess_documentation_relevance/subprocesses/load_stored_digests.rb

Overview

Top-level module for DocGuard gem functionality.

Examples:

Raise a custom DocGuard error

raise DocGuard::Error, "something went wrong"

Defined Under Namespace

Modules: AssessDocumentationRelevance, RecordDocumentationRelevance, Shared Classes: Cli, Config, Error

Constant Summary collapse

VERSION =

Current version of the DocGuard gem.

"1.0.0"