Skip to content

Commit

Permalink
apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Jimmy Debe <[email protected]>
  • Loading branch information
chaitanyaprem and jimstir committed Jan 2, 2025
1 parent f5170ec commit 58d1abf
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions waku/informational/23/topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,13 +132,13 @@ for the [WakuMessage payload](../../standards/core/14/message.md/#payloads) fiel
### Content Topic usage guidelines

Applications should be mindful while designing/using content topics so that a bloat of content-topics does not happen.

Check failure on line 134 in waku/informational/23/topics.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

waku/informational/23/topics.md:134:119 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md009.md
A content topic bloat causes performance degradation in Store and Filter protocols while trying to retrieve messages.
A content-topic bloat causes performance degradation in [13/WAKU2 -STORE](/waku/standards/core/13/store.md) and [12/WAKU2-FILTER](/waku/standards/core/13/filter.md) protocols while trying to retrieve messages.

Store queries have been noticed to be considerably slow (e.g doubling of response-time when content-topic count is increased from 10 to 100) when a lot of content-topics are involved in a single query.
Similarly number of filter subscriptions increase, which increases complexity on client side to maintain and manage these subscriptions.

Applications should analyze the query/filter criteria for fetching messages from the network and select/design content topics to match such filter criteria.

Check failure on line 140 in waku/informational/23/topics.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

waku/informational/23/topics.md:140:157 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md009.md
e.g: eventhough applications may want to segregate messages into different sets based on some application logic, if those sets of messages are always fetched/queried together from the network, then all those messages should use a single content-topic.
e.g: even though applications may want to segregate messages into different sets based on some application logic, if those sets of messages are always fetched/queried together from the network, then all those messages should use a single content-topic.

Check failure on line 141 in waku/informational/23/topics.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

waku/informational/23/topics.md:141:253 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md009.md


Check failure on line 143 in waku/informational/23/topics.md

View workflow job for this annotation

GitHub Actions / lint

Multiple consecutive blank lines

waku/informational/23/topics.md:143 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md012.md
## Differences with Waku v1
Expand Down

0 comments on commit 58d1abf

Please sign in to comment.