filecoin-project / filecoin-project/specs

Round vs. epoch

Open
#690 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
SCSS
Stars
363
Forks
164
PR merge metrics
No merged PRs in 30d

Description

`round` and `epoch` are used interchangeably in many places across the spec. Although they're official synonyms, this causes confusion for implementers who have not otherwise stumbled across that fact.

We should do a pass and replace all mentions of round with epoch where reasonable, and especially in code or pseudocode. For example, `ROUND_CUTOFF` should be `EPOCH_CUTOFF`.

**Priority:** Not urgent, can be done after spec is feature complete.

cc @ZenGround0 @sternhenri

Contributor guide

No contributing guide indexed for this repository

Research direction

Search the specification for uses of “round,” prioritizing code and pseudocode, and inspect the ROUND_CUTOFF example in context. Review each occurrence for whether “epoch” is an appropriate replacement, then confirm that terminology is consistent throughout the specification without changing cases where “round” remains clearer.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.