Skip to content

Commit

Permalink
progresslog: Add package documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
davecgh committed Dec 15, 2020
1 parent 6c0f088 commit 7a80939
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
26 changes: 26 additions & 0 deletions internal/progresslog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
progresslog
===========

[![Build Status](https://github.com/decred/dcrd/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/dcrd/actions)
[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![Doc](https://img.shields.io/badge/doc-reference-blue.svg)](https://pkg.go.dev/github.com/decred/dcrd/internal/progresslog)

Package progresslog provides periodic logging for block processing.

Tests are included to ensure proper functionality.

## Feature Overview

- Maintains cumulative totals about blocks between each logging interval
- Total number of blocks
- Total number of transactions
- Total number of votes
- Total number of tickets
- Total number of revocations
- Logs all cumulative data every 10 seconds
- Immediately logs any outstanding data when the provided sync height is reached

## License

Package progresslog is licensed under the [copyfree](http://copyfree.org) ISC
License.
21 changes: 21 additions & 0 deletions internal/progresslog/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Copyright (c) 2020 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.

/*
Package progresslog provides periodic logging for block processing.
Tests are included to ensure proper functionality.
## Feature Overview
- Maintains cumulative totals about blocks between each logging interval
- Total number of blocks
- Total number of transactions
- Total number of votes
- Total number of tickets
- Total number of revocations
- Logs all cumulative data every 10 seconds
- Immediately logs any outstanding data when the provided sync height is reached
*/
package progresslog

0 comments on commit 7a80939

Please sign in to comment.