Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cspell documentation lists version as always 0.1 #1638

Closed
4 of 20 tasks
CreativeTechGuy opened this issue Sep 5, 2021 · 2 comments · Fixed by #1640
Closed
4 of 20 tasks

cspell documentation lists version as always 0.1 #1638

CreativeTechGuy opened this issue Sep 5, 2021 · 2 comments · Fixed by #1640

Comments

@CreativeTechGuy
Copy link

Info

Kind of Issue

  • runtime - command-line tools
  • building / compiling
  • security
  • change in behavior
  • crash / error
  • documentation

Which Tool or library

  • cspell -- the command-line spelling tool
  • cspell-tools -- used for building dictionary files
  • cspell-lib -- library that does the actual spell checking.
  • cspell-trie -- tool for working with trie files.

Which Version

Version: Latest docs

Issue with supporting library?

  • No
  • cspell-glob -- library for matching glob patterns
  • cspell-io -- thin file i/o library
  • cspell-trie-lib - trie lib
  • cspell-trie2-lib - trie lib alternate format

OS:

  • Macos
  • Linux
  • Windows
  • Other
  • All

version:

OS version if applicable.

Bug Description

Describe the bug

https://github.com/streetsidesoftware/cspell/blame/main/packages/cspell/README.md#L454

This line of the readme says:

`version` - currently always 0.1

Yet just a few lines above it says:

Version of the setting file.  Always 0.2

To Reproduce

Steps to reproduce the behavior:

  1. Visit documentation: https://www.npmjs.com/package/cspell
  2. Scroll down to "cspell.json sections"
  3. See version: 0.1
  4. Use 0.1 in config file
  5. See deprecation message in IDE telling you to use 0.2

Expected behavior

The documentation should be internally consistent.

Screenshots

N/A

Additional context

N/A

cspell.json

N/A

Example Repository (Optional)

N/A

@Jason3S
Copy link
Collaborator

Jason3S commented Sep 6, 2021

Thank you. I must have missed some references.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 7, 2021

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 7, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants