Documentation needed to add words

[ccoVeille]

Is there a place where you documented the way to add words?

I'm talking about here the special case "dataCenter", sometimes there is a need to use ^, sometimes ~, here it was about using an uppercase C in data center

What would be the way to write a brand that has a dedicated syntax? Like : Elasticsearch brand that is not elasticseach or ElasticSearch

Originally posted by @ccoVeille in https://github.com/streetsidesoftware/cspell-dicts/pull/3846#discussion_r1860991592

[ccoVeille]

Let's pull out my question from the other PR, and write it here

what would be the syntax to only allow "konami code" ?so konami would be allowed but only followed with code.

Konami is a brand that could be added to brands dictionary.

But "Konami code" is definitely a coding term.

Originally posted by @ccoVeille in https://github.com/streetsidesoftware/cspell-dicts/pull/3881#discussion_r1882002410

You replied to PR author about what it could do with konami as a brand.

My question was more general in fact.

When there are words that only exists together like "foo bar", here the example was "konami code", what would be the syntax for allowing "foo bar" only

[Jason3S]

@ccoVeille,

When there are words that only exists together like "foo bar", here the example was "konami code", what would be the syntax for allowing "foo bar" only

There isn't currently support for checking multiple words separated by a space. It is not an easy problem.

[ccoVeille]

Thanks

I hope that I'll be able to help you to write a documentation by keep asking you questions like this one 🤭

[ccoVeille]

Other information shared in another PR

Another option, is to have everything with leading caps:

`I+` and `*Line*`.

Based upon the `caseSensitive` setting, it can prevent false negatives in normal text:

When writing text and `caseSensitive` is `true`, it will not match against `iline`, only `ILine`. When writing code and `caseSensitive` is `false`, it will match.

Originally posted by @Jason3S in https://github.com/streetsidesoftware/cspell-dicts/pull/3920#discussion_r1897865162

Follow-up with https://github.com/streetsidesoftware/cspell-dicts/pull/3937

[ccoVeille]

Interesting comment made in a review, copy-pasted here for archive and future reference

The point was to create the shared acronyms file. I was trying to avoid adding US centric terms.

As far as duplicate words, that is not an issue. When the dictionary is built, all duplications are removed.

I would rather a word appear in multiple source files rather than trying to decided exactly which source file is should be in. Context can often be a factor. As you pointed out in a different issue decluttering could be a software term referring to cleaning up images or an activity to have a neat and tidy house. Originally posted by @Jason3S in https://github.com/streetsidesoftware/cspell-dicts/pull/4340#discussion_r2071213093

[ccoVeille]

I feel like the following PR achieved a part of this PR

• https://github.com/streetsidesoftware/cspell-dicts/pull/4574

There are still a few things to document, but the situation is way better than when I opened the issue.

Maybe @keith-oak would have interest in reading this issue, as he opened #4574