Fix Filters documentation - #570

Thank you :) Do you want to add yourself to AUTHORS.rst before I merge?

Actually, this fails on the flake8 pre-commit hook. To quote @bomjacob:

I think that's the original reason I had for not including those MessageEntity in the first place, since the docs can't show it properly if you break it into two lines either...

If you can solve this without exceeding the maximum line length of 99 characters while still producing a nice-looking doc page, that would be great.

@Eldinnie That sounds reasonable to me

To make sure it doesn't show up in the rendered HTML page, it should also be prepended with .. (rst comment). Not sure if this works inline though.

Yeah, that's some pretty hard line to break. Are you up to add the comment yourself? As it allows edits from maintainers.

yes so to be complete: append the line that's too long with .. # noqa: E501 to make it pass flake8's test but not show up in the docs.

I don't get what's wrong this time, coveralls is showing all errors, not only those added by this PR :-?

You can ignore the coveralls check for changes like this, it sometimes fucks up

Done

Sadly, it does not seem to work :/

Where is that screenshot from?

I cloned your repo/branch and built the documentation

With Sphinx?

Yes. python setup.py build_sphinx

@jh0ker autodoc maybe ignores it... dunno how to make it ignored in the docs

Would this:

        >>> (
        >>>     Filters.text & (
        >>>         Filters.entity(MessageEntity.URL) | Filters.entity(MessageEntity.TEXT_LINK)
        >>>     )
        >>> )

be acceptable? I think it also helps the readability by separating those 3 ending parenthesis.

I think that is a reasonable compromise. Please use ... instead of >>> to denote the continued expression over multiple lines

I didn't know the exact syntax, I added now the commit.

Why are there so many unhashable type: 'list' errors in Travis?

@revolter see #579

I overhauled filters docs in #728 so closing this one.