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

Added stopwords: _none_ to the docs #329 #4698

Closed
wants to merge 2 commits into from
Closed

Conversation

mrkamel
Copy link

@mrkamel mrkamel commented Jan 12, 2014

I'm missing stopwords: _none_ in the docs, as well as a stopwords: ... section within the pattern analyzer docs.

@clintongormley
Copy link

Hi @mrkamel

Many thanks for this PR. Reading through it made me realise that we have some inconsistent changes coming up. In 1.0 we have set the default stopwords list on new indices for the standard analyzer to _none_ (which apparently isn't documented yet).

I've just opened #4699 to get the pattern and standard_html analyzers changed to default to _none_. We should probably wait for that before moving forward with this PR.

Also, please could you sign the CLA http://www.elasticsearch.org/contributor-agreement so that we can accept these changes.

many thanks

@mrkamel
Copy link
Author

mrkamel commented Jan 12, 2014

a) The docs of master state

A list of stopwords to initialize the stop filter with.
Defaults to an 'empty' stopword list added[1.0.0.Beta1, Previously 
defaulted to the English stopwords list]

b) I agree, we should wait for the removal of inconsistencies
c) Signed
d) You're right, it's probably not the best page to add this section. However, i used it since

        ...
        stopwords : [test1, test2, test3]

was already listed in the page's sample config. Thus, i assume stopwords should not be listed on this page at all and we should provide an extra page for them to have less duplication in the docs and then reference it where neccessary. Where do you want it to live? analysis/analyzers/stopwords.asciidoc?

@mrkamel
Copy link
Author

mrkamel commented Jan 13, 2014

Great, #4699 seems to be fixed. Do you agree to my proposal in d) ?
I'd create another pull request then ... and close this one

@clintongormley
Copy link

Heya

Re:
(a) - I missed that :)
(b) done, we won't document StandardHtml
(c) Great, thanks!
(d) I would:

  • leave the stopwords example as it was originally on the analyzers page - it's just an example, doesn't need full documentation
  • document stopwords fully on analysis/analyzers/stop-analyzer.asciidoc (note the default here is still english)
  • refer to the above from standard and pattern analyzers, noting that the default for these is _none_

No need to close this PR, you can just update it and push again.

thanks for helping @mrkamel

@clintongormley
Copy link

also please include the coming[1.0.0.RC1,Previously defaulted to the English stopwords] on the pattern analyzer page, and please rebase your PR on master.

ta

@mrkamel
Copy link
Author

mrkamel commented Jan 13, 2014

Before, may i finally ask why ES actually uses such kind of special keyword _none_? I'd at least expect stopwords: [] to work while being much more self-explanatory and yaml-like, thus making this PR unnecessary. However, stopwords: [] or stopwords: "" doesn't work in my tests.

Sorry for being pedantic, but i don't easily find an obvious hint within the sources.

@clintongormley
Copy link

Good question, and I don't know either :) Looks like an empty list isn't being considered currently.

I've opened #4709 to get support added (but this may take a little while as we're getting ready for the next release now).

@clintongormley
Copy link

Merged! Many thanks for the PR @mrkamel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants