synapse icon indicating copy to clipboard operation
synapse copied to clipboard

Description for filter_timeline_limit is misleading

Open deepbluev7 opened this issue 1 year ago • 0 comments

Description

Looking at the documentation for filter_timeline_limit: https://github.com/matrix-org/synapse/blob/master/docs/usage/configuration/config_documentation.md#filter_timeline_limit

This says it would set the limit for the events returned on /sync. But it actually sets the upper limit for the limit parameter.

For example the default for the filter_timeline_limit is 100, but the actual default limit for events returned during /sync is 10: https://github.com/matrix-org/synapse/blob/c52abc1cfdd9e5480cdb4a03d626fe61cacc6573/synapse/api/filtering.py#L302

One way to fix that is by simply making the documentation more explicit, but I think it would actually be helpful to also rename the limit configuration parameter to something like "max_allowed_filter_timeline_limit" or so.

Steps to reproduce

Read the docs linked above.

Homeserver


Synapse Version

1.65.0rc1

Installation Method

No response

Platform


Relevant log output

<br>

Anything else that would be useful to know?

No response

deepbluev7 avatar Aug 13 '22 17:08 deepbluev7