Skip to content

Idea: Frequency/rate is used incorrectly in script documentation and flags, leading to confusion. #5831

@donottellmetonottellyou

Description

Technically, the usage was incorrect, but semantically it was correct.

If the number goes down with the amount of the thing, it isn't a frequency (or rate), it's the inverse, "wavelength" or in this case perhaps "interval". Frequency goes up with increased frequency, not down. However, an interval goes down with increased frequency.

There are other inconsistencies, like how starvingdead calls its poll interval a "rate". So it would have to be a comprehensive change across all the tools. I don't think anything in dfhack actually uses frequency or rate correctly because actually calculating from frequency would be an extra step. Everything is based on poll periods (and a lot of the tools aren't that accurate anyway). But changing how the flags work at this point might be more trouble than it's worth.

Originally posted by @donottellmetonottellyou in #5570

Not sure if anyone is even interested in accepting patches for this. Possibly a solution would be to add a --update-days, --update-period, or --update-interval flag to every relevant command which would become the new default, documented command, while the old incorrectly named flag would be left as a legacy alias.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions