Skip to content

Usage of refresh rate terminology is confusing #73

@aignas

Description

@aignas

Just installed it and it works very well, but going through the docs, I noticed the usage of "refresh rate" term, which means how many times per given time period something is refreshed. The higher the refresh rate, the more times the refresh is happening.

However, in the docs, the refresh rate is used synonymous to refresh timeout. Since this would cause an incompatible change because of the naming confusion present in the settings, I am creating this issue before submitting any PRs for this.

Here is a search for "refresh rate": https://github.com/euclio/vim-markdown-composer/search?q=refresh+rate&unscoped_q=refresh+rate

I would propose to have refresh_period or refresh_every instead of refresh_rate.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions