Skip to content

Java SDK docs

Java SDK docs #218

Triggered via pull request October 26, 2023 15:14
Status Failure
Total duration 2m 3s
Artifacts

test-build.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

20 errors, 49 warnings, and 77 notices
[vale] docs/services/sdk/side-effects.mdx#L37: docs/services/sdk/side-effects.mdx#L37
[Vale.Spelling] Did you really mean 'deserialize'?
[vale] docs/services/sdk/state.mdx#L52: docs/services/sdk/state.mdx#L52
[Vale.Spelling] Did you really mean 'serializers'?
[vale] docs/services/sdk/serving.mdx#L195: docs/services/sdk/serving.mdx#L195
[Vale.Spelling] Did you really mean 'binded'?
[vale] docs/services/sdk/awakeables.mdx#L48: docs/services/sdk/awakeables.mdx#L48
[Vale.Spelling] Did you really mean 'deserializes'?
[vale] docs/services/sdk/awakeables.mdx#L65: docs/services/sdk/awakeables.mdx#L65
[Vale.Spelling] Did you really mean 'awakeable'?
[vale] docs/services/sdk/awakeables.mdx#L65: docs/services/sdk/awakeables.mdx#L65
[Vale.Spelling] Did you really mean 'deserialize'?
[vale] docs/services/sdk/overview.mdx#L27: docs/services/sdk/overview.mdx#L27
[Vale.Spelling] Did you really mean 'Protobuf'?
[vale] docs/services/sdk/overview.mdx#L36: docs/services/sdk/overview.mdx#L36
[proselint.Annotations] 'TODO' left in text.
[vale] docs/services/sdk/overview.mdx#L101: docs/services/sdk/overview.mdx#L101
[Vale.Spelling] Did you really mean 'Protobuf'?
[vale] docs/services/sdk/overview.mdx#L101: docs/services/sdk/overview.mdx#L101
[write-good.So] Don't start a sentence with 'So '.
[vale] docs/services/sdk/overview.mdx#L150: docs/services/sdk/overview.mdx#L150
[Vale.Spelling] Did you really mean 'Protobuf'?
[vale] docs/services/sdk/overview.mdx#L224: docs/services/sdk/overview.mdx#L224
[Vale.Spelling] Did you really mean 'Protobuf'?
[vale] docs/services/sdk/overview.mdx#L225: docs/services/sdk/overview.mdx#L225
[Google.Latin] Use 'for example' instead of 'e.g.'.
[vale] docs/services/sdk/overview.mdx#L228: docs/services/sdk/overview.mdx#L228
[Vale.Spelling] Did you really mean 'Protobuf'?
[vale] docs/services/sdk/overview.mdx#L252: docs/services/sdk/overview.mdx#L252
[Vale.Spelling] Did you really mean 'Protobuf'?
[vale] docs/services/sdk/overview.mdx#L257: docs/services/sdk/overview.mdx#L257
[Google.Exclamation] Don't use exclamation points in text.
[vale] docs/services/sdk/kafka.mdx#L213: docs/services/sdk/kafka.mdx#L213
[write-good.ThereIs] Don't start a sentence with 'There are'.
Test build
Process completed with exit code 1.
[vale] docs/services/sdk/side-effects.mdx#L37: docs/services/sdk/side-effects.mdx#L37
[write-good.TooWordy] 'type of' is too wordy.
[vale] docs/services/sdk/side-effects.mdx#L56: docs/services/sdk/side-effects.mdx#L56
[write-good.TooWordy] 'it is' is too wordy.
[vale] docs/services/sdk/side-effects.mdx#L56: docs/services/sdk/side-effects.mdx#L56
[write-good.Passive] 'is retried' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/side-effects.mdx#L97: docs/services/sdk/side-effects.mdx#L97
[write-good.Passive] 'be handled' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/side-effects.mdx#L98: docs/services/sdk/side-effects.mdx#L98
[write-good.Passive] 'be recorded' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/state.mdx#L10: docs/services/sdk/state.mdx#L10
[write-good.Passive] 'be retrieved' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/state.mdx#L10: docs/services/sdk/state.mdx#L10
[write-good.TooWordy] 'additional' is too wordy.
[vale] docs/services/sdk/state.mdx#L22: docs/services/sdk/state.mdx#L22
[Google.FirstPerson] Avoid first-person pronouns such as 'my'.
[vale] docs/services/sdk/state.mdx#L23: docs/services/sdk/state.mdx#L23
[Google.Will] Avoid using 'will'.
[vale] docs/services/sdk/state.mdx#L23: docs/services/sdk/state.mdx#L23
[write-good.Passive] 'was stored' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/state.mdx#L23: docs/services/sdk/state.mdx#L23
[Google.Will] Avoid using 'will'.
[vale] docs/services/sdk/state.mdx#L23: docs/services/sdk/state.mdx#L23
[write-good.Passive] 'was stored' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/state.mdx#L25: docs/services/sdk/state.mdx#L25
[write-good.Passive] 'be serialized' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/state.mdx#L34: docs/services/sdk/state.mdx#L34
[Google.Will] Avoid using 'will'.
[vale] docs/services/sdk/state.mdx#L39: docs/services/sdk/state.mdx#L39
[Google.Colons] ': F' should be in lowercase.
[vale] docs/services/sdk/state.mdx#L68: docs/services/sdk/state.mdx#L68
[Google.Will] Avoid using 'will'.
[vale] docs/services/sdk/state.mdx#L68: docs/services/sdk/state.mdx#L68
[write-good.Passive] 'was stored' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/state.mdx#L68: docs/services/sdk/state.mdx#L68
[Google.Will] Avoid using 'will'.
[vale] docs/services/sdk/state.mdx#L68: docs/services/sdk/state.mdx#L68
[write-good.Passive] 'was stored' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/state.mdx#L85: docs/services/sdk/state.mdx#L85
[write-good.Passive] 'be serialized' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/state.mdx#L94: docs/services/sdk/state.mdx#L94
[write-good.Passive] 'was defined' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/serving.mdx#L136: docs/services/sdk/serving.mdx#L136
[write-good.TooWordy] 'multiple' is too wordy.
[vale] docs/services/sdk/serving.mdx#L138: docs/services/sdk/serving.mdx#L138
[write-good.Weasel] 'Finally' is a weasel word!
[vale] docs/services/sdk/durable-timers.mdx#L48: docs/services/sdk/durable-timers.mdx#L48
[write-good.TooWordy] 'benefit from' is too wordy.
[vale] docs/services/sdk/awakeables.mdx#L65: docs/services/sdk/awakeables.mdx#L65
[write-good.TooWordy] 'type of' is too wordy.
[vale] docs/services/sdk/error-handling.mdx#L16: docs/services/sdk/error-handling.mdx#L16
[write-good.Passive] 'be propagated' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/overview.mdx#L19: docs/services/sdk/overview.mdx#L19
[write-good.Weasel] 'quickly' is a weasel word!
[vale] docs/services/sdk/overview.mdx#L27: docs/services/sdk/overview.mdx#L27
[Google.OxfordComma] Use the Oxford comma in 'The gRPC API requires you to specify the services, methods and'.
[vale] docs/services/sdk/overview.mdx#L35: docs/services/sdk/overview.mdx#L35
[write-good.Weasel] 'quickly' is a weasel word!
[vale] docs/services/sdk/overview.mdx#L54: docs/services/sdk/overview.mdx#L54
[Google.Headings] 'API Examples' should use sentence-style capitalization.
[vale] docs/services/sdk/overview.mdx#L150: docs/services/sdk/overview.mdx#L150
[write-good.Passive] 'is defined' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/overview.mdx#L150: docs/services/sdk/overview.mdx#L150
[write-good.Passive] 'are shown' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/overview.mdx#L224: docs/services/sdk/overview.mdx#L224
[write-good.Passive] 'is defined' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/overview.mdx#L224: docs/services/sdk/overview.mdx#L224
[write-good.Passive] 'are shown' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/overview.mdx#L225: docs/services/sdk/overview.mdx#L225
[write-good.Passive] 'is retrieved' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/overview.mdx#L226: docs/services/sdk/overview.mdx#L226
[write-good.Weasel] 'Finally' is a weasel word!
[vale] docs/services/sdk/overview.mdx#L226: docs/services/sdk/overview.mdx#L226
[write-good.Passive] 'is set' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/overview.mdx#L257: docs/services/sdk/overview.mdx#L257
[Google.We] Try to avoid using first-person plural like 'let's'.
[vale] docs/services/sdk/kafka.mdx#L211: docs/services/sdk/kafka.mdx#L211
[write-good.Passive] 'are delivered' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/kafka.mdx#L217: docs/services/sdk/kafka.mdx#L217
[write-good.Weasel] 'only' is a weasel word!
[vale] docs/services/sdk/kafka.mdx#L236: docs/services/sdk/kafka.mdx#L236
[write-good.Passive] 'is keyed' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/kafka.mdx#L236: docs/services/sdk/kafka.mdx#L236
[write-good.Passive] 'are delivered' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/kafka.mdx#L237: docs/services/sdk/kafka.mdx#L237
[Google.Will] Avoid using 'will'.
[vale] docs/services/sdk/kafka.mdx#L237: docs/services/sdk/kafka.mdx#L237
[write-good.Passive] 'be delivered' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/kafka.mdx#L239: docs/services/sdk/kafka.mdx#L239
[write-good.Passive] 'is serialized' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/kafka.mdx#L239: docs/services/sdk/kafka.mdx#L239
[write-good.Passive] 'is encoded' may be passive voice. Use active voice if you can.
[vale] docs/services/sdk/side-effects.mdx#L6: docs/services/sdk/side-effects.mdx#L6
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/side-effects.mdx#L7: docs/services/sdk/side-effects.mdx#L7
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/side-effects.mdx#L56: docs/services/sdk/side-effects.mdx#L56
[Google.Contractions] Use 'it's' instead of 'it is'.
[vale] docs/services/sdk/side-effects.mdx#L56: docs/services/sdk/side-effects.mdx#L56
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/side-effects.mdx#L56: docs/services/sdk/side-effects.mdx#L56
[Google.Passive] In general, use active voice instead of passive voice ('is retried').
[vale] docs/services/sdk/side-effects.mdx#L97: docs/services/sdk/side-effects.mdx#L97
[write-good.E-Prime] Try to avoid using 'be'.
[vale] docs/services/sdk/side-effects.mdx#L97: docs/services/sdk/side-effects.mdx#L97
[Google.Passive] In general, use active voice instead of passive voice ('be handled').
[vale] docs/services/sdk/side-effects.mdx#L98: docs/services/sdk/side-effects.mdx#L98
[Google.Passive] In general, use active voice instead of passive voice ('be recorded').
[vale] docs/services/sdk/state.mdx#L6: docs/services/sdk/state.mdx#L6
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/state.mdx#L7: docs/services/sdk/state.mdx#L7
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/state.mdx#L10: docs/services/sdk/state.mdx#L10
[write-good.E-Prime] Try to avoid using 'be'.
[vale] docs/services/sdk/state.mdx#L10: docs/services/sdk/state.mdx#L10
[Google.Passive] In general, use active voice instead of passive voice ('be retrieved').
[vale] docs/services/sdk/state.mdx#L23: docs/services/sdk/state.mdx#L23
[write-good.E-Prime] Try to avoid using 'was'.
[vale] docs/services/sdk/state.mdx#L23: docs/services/sdk/state.mdx#L23
[Google.Passive] In general, use active voice instead of passive voice ('was stored').
[vale] docs/services/sdk/state.mdx#L23: docs/services/sdk/state.mdx#L23
[write-good.E-Prime] Try to avoid using 'was'.
[vale] docs/services/sdk/state.mdx#L23: docs/services/sdk/state.mdx#L23
[Google.Passive] In general, use active voice instead of passive voice ('was stored').
[vale] docs/services/sdk/state.mdx#L25: docs/services/sdk/state.mdx#L25
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/state.mdx#L25: docs/services/sdk/state.mdx#L25
[write-good.E-Prime] Try to avoid using 'be'.
[vale] docs/services/sdk/state.mdx#L25: docs/services/sdk/state.mdx#L25
[Google.Passive] In general, use active voice instead of passive voice ('be serialized').
[vale] docs/services/sdk/state.mdx#L34: docs/services/sdk/state.mdx#L34
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/state.mdx#L39: docs/services/sdk/state.mdx#L39
[Google.Parens] Use parentheses judiciously.
[vale] docs/services/sdk/state.mdx#L68: docs/services/sdk/state.mdx#L68
[Google.Passive] In general, use active voice instead of passive voice ('was stored').
[vale] docs/services/sdk/state.mdx#L68: docs/services/sdk/state.mdx#L68
[write-good.E-Prime] Try to avoid using 'was'.
[vale] docs/services/sdk/state.mdx#L68: docs/services/sdk/state.mdx#L68
[write-good.E-Prime] Try to avoid using 'was'.
[vale] docs/services/sdk/state.mdx#L68: docs/services/sdk/state.mdx#L68
[Google.Passive] In general, use active voice instead of passive voice ('was stored').
[vale] docs/services/sdk/state.mdx#L85: docs/services/sdk/state.mdx#L85
[write-good.E-Prime] Try to avoid using 'be'.
[vale] docs/services/sdk/state.mdx#L85: docs/services/sdk/state.mdx#L85
[Google.Passive] In general, use active voice instead of passive voice ('be serialized').
[vale] docs/services/sdk/state.mdx#L94: docs/services/sdk/state.mdx#L94
[Google.Parens] Use parentheses judiciously.
[vale] docs/services/sdk/state.mdx#L94: docs/services/sdk/state.mdx#L94
[write-good.E-Prime] Try to avoid using 'was'.
[vale] docs/services/sdk/state.mdx#L94: docs/services/sdk/state.mdx#L94
[Google.Passive] In general, use active voice instead of passive voice ('was defined').
[vale] docs/services/sdk/state.mdx#L99: docs/services/sdk/state.mdx#L99
[write-good.E-Prime] Try to avoid using 'are'.
[vale] docs/services/sdk/state.mdx#L124: docs/services/sdk/state.mdx#L124
[write-good.E-Prime] Try to avoid using 'are'.
[vale] docs/services/sdk/durable-timers.mdx#L6: docs/services/sdk/durable-timers.mdx#L6
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/durable-timers.mdx#L7: docs/services/sdk/durable-timers.mdx#L7
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/durable-timers.mdx#L48: docs/services/sdk/durable-timers.mdx#L48
[Google.Contractions] Use 'don't' instead of 'do not'.
[vale] docs/services/sdk/awakeables.mdx#L6: docs/services/sdk/awakeables.mdx#L6
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/awakeables.mdx#L7: docs/services/sdk/awakeables.mdx#L7
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/error-handling.mdx#L6: docs/services/sdk/error-handling.mdx#L6
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/error-handling.mdx#L7: docs/services/sdk/error-handling.mdx#L7
[Google.Semicolons] Use semicolons judiciously.
[vale] docs/services/sdk/error-handling.mdx#L16: docs/services/sdk/error-handling.mdx#L16
[write-good.E-Prime] Try to avoid using 'be'.
[vale] docs/services/sdk/error-handling.mdx#L16: docs/services/sdk/error-handling.mdx#L16
[Google.Passive] In general, use active voice instead of passive voice ('be propagated').
[vale] docs/services/sdk/error-handling.mdx#L28: docs/services/sdk/error-handling.mdx#L28
[write-good.E-Prime] Try to avoid using 'are'.
[vale] docs/services/sdk/overview.mdx#L150: docs/services/sdk/overview.mdx#L150
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/overview.mdx#L150: docs/services/sdk/overview.mdx#L150
[Google.Passive] In general, use active voice instead of passive voice ('is defined').
[vale] docs/services/sdk/overview.mdx#L150: docs/services/sdk/overview.mdx#L150
[Google.Passive] In general, use active voice instead of passive voice ('are shown').
[vale] docs/services/sdk/overview.mdx#L150: docs/services/sdk/overview.mdx#L150
[write-good.E-Prime] Try to avoid using 'are'.
[vale] docs/services/sdk/overview.mdx#L185: docs/services/sdk/overview.mdx#L185
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/overview.mdx#L224: docs/services/sdk/overview.mdx#L224
[Google.Passive] In general, use active voice instead of passive voice ('is defined').
[vale] docs/services/sdk/overview.mdx#L224: docs/services/sdk/overview.mdx#L224
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/overview.mdx#L224: docs/services/sdk/overview.mdx#L224
[Google.Passive] In general, use active voice instead of passive voice ('are shown').
[vale] docs/services/sdk/overview.mdx#L224: docs/services/sdk/overview.mdx#L224
[write-good.E-Prime] Try to avoid using 'are'.
[vale] docs/services/sdk/overview.mdx#L225: docs/services/sdk/overview.mdx#L225
[Google.Passive] In general, use active voice instead of passive voice ('is retrieved').
[vale] docs/services/sdk/overview.mdx#L225: docs/services/sdk/overview.mdx#L225
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/overview.mdx#L225: docs/services/sdk/overview.mdx#L225
[Google.Parens] Use parentheses judiciously.
[vale] docs/services/sdk/overview.mdx#L226: docs/services/sdk/overview.mdx#L226
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/overview.mdx#L226: docs/services/sdk/overview.mdx#L226
[Google.Passive] In general, use active voice instead of passive voice ('is set').
[vale] docs/services/sdk/overview.mdx#L228: docs/services/sdk/overview.mdx#L228
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/kafka.mdx#L208: docs/services/sdk/kafka.mdx#L208
[write-good.E-Prime] Try to avoid using 'you're'.
[vale] docs/services/sdk/kafka.mdx#L208: docs/services/sdk/kafka.mdx#L208
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/kafka.mdx#L211: docs/services/sdk/kafka.mdx#L211
[Google.Parens] Use parentheses judiciously.
[vale] docs/services/sdk/kafka.mdx#L211: docs/services/sdk/kafka.mdx#L211
[Google.Passive] In general, use active voice instead of passive voice ('are delivered').
[vale] docs/services/sdk/kafka.mdx#L211: docs/services/sdk/kafka.mdx#L211
[write-good.E-Prime] Try to avoid using 'are'.
[vale] docs/services/sdk/kafka.mdx#L213: docs/services/sdk/kafka.mdx#L213
[write-good.E-Prime] Try to avoid using 'are'.
[vale] docs/services/sdk/kafka.mdx#L215: docs/services/sdk/kafka.mdx#L215
[write-good.E-Prime] Try to avoid using 'be'.
[vale] docs/services/sdk/kafka.mdx#L216: docs/services/sdk/kafka.mdx#L216
[write-good.E-Prime] Try to avoid using 'be'.
[vale] docs/services/sdk/kafka.mdx#L236: docs/services/sdk/kafka.mdx#L236
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/kafka.mdx#L236: docs/services/sdk/kafka.mdx#L236
[Google.Passive] In general, use active voice instead of passive voice ('is keyed').
[vale] docs/services/sdk/kafka.mdx#L236: docs/services/sdk/kafka.mdx#L236
[Google.Passive] In general, use active voice instead of passive voice ('are delivered').
[vale] docs/services/sdk/kafka.mdx#L236: docs/services/sdk/kafka.mdx#L236
[write-good.E-Prime] Try to avoid using 'are'.
[vale] docs/services/sdk/kafka.mdx#L237: docs/services/sdk/kafka.mdx#L237
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/kafka.mdx#L237: docs/services/sdk/kafka.mdx#L237
[Google.Passive] In general, use active voice instead of passive voice ('be delivered').
[vale] docs/services/sdk/kafka.mdx#L237: docs/services/sdk/kafka.mdx#L237
[write-good.E-Prime] Try to avoid using 'be'.
[vale] docs/services/sdk/kafka.mdx#L239: docs/services/sdk/kafka.mdx#L239
[write-good.E-Prime] Try to avoid using 'be'.
[vale] docs/services/sdk/kafka.mdx#L239: docs/services/sdk/kafka.mdx#L239
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/kafka.mdx#L239: docs/services/sdk/kafka.mdx#L239
[Google.Passive] In general, use active voice instead of passive voice ('is serialized').
[vale] docs/services/sdk/kafka.mdx#L239: docs/services/sdk/kafka.mdx#L239
[write-good.E-Prime] Try to avoid using 'is'.
[vale] docs/services/sdk/kafka.mdx#L239: docs/services/sdk/kafka.mdx#L239
[Google.Passive] In general, use active voice instead of passive voice ('is encoded').