diff mbox series

media: Documentation: dev-subdev: Fix sentence conjunction

Message ID 20240412092836.69031-1-umang.jain@ideasonboard.com (mailing list archive)
State Rejected
Headers show
Series media: Documentation: dev-subdev: Fix sentence conjunction | expand

Commit Message

Umang Jain April 12, 2024, 9:28 a.m. UTC
Fix sentence conjunction in the streams and routes section.

Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
---
 Documentation/userspace-api/media/v4l/dev-subdev.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Kieran Bingham April 12, 2024, 9:46 a.m. UTC | #1
Hi Umang,

Quoting Umang Jain (2024-04-12 10:28:36)
> Fix sentence conjunction in the streams and routes section.
> 
> Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
> ---
>  Documentation/userspace-api/media/v4l/dev-subdev.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/userspace-api/media/v4l/dev-subdev.rst b/Documentation/userspace-api/media/v4l/dev-subdev.rst
> index 43988516acdd..7f6620cbdf78 100644
> --- a/Documentation/userspace-api/media/v4l/dev-subdev.rst
> +++ b/Documentation/userspace-api/media/v4l/dev-subdev.rst
> @@ -561,7 +561,7 @@ selections. The order of configuring formats and selections along a stream is
>  the same as without streams (see :ref:`format-propagation`).
>  
>  Instead of the sub-device wide merging of streams from all sink pads
> -towards all source pads, data flows for each route are separate from each
> +towards all source pads, data flows for each route that are separate from each

I'm not sure this is correct I'm afraid.

The original explains that there are multiple flows of data ('streams?')
and that they are each separate (and can flow in different routes?)

I would only expect a 'that' if there was some further expansion which
doesn't follow.

In fact, I just tried, and I can't make the little green 'grammar-ok'
light in my head illuminate when there is a 'that' added here ;-S


My grammar skills are not good enough to distinguish/explain precisely
except for that magic builtin-native-speaker-right-wrong check and so
ChatGPT (take with a pinch of salt) explained the following:

https://chat.openai.com/share/632bbcae-22f7-4b42-bbe0-6f9178a36d14

Between Sentence A and Sentence B, Sentence A is more grammatically
correct.

Sentence A: "Instead of the sub-device wide merging of streams from all
sink pads towards all source pads, data flows for each route are
separate from each other."

In this sentence, "data flows for each route are separate from each
other" is a clear and independent clause, indicating that the data flows
are separate for each route.

Sentence B: "Instead of the sub-device wide merging of streams from all
sink pads towards all source pads, data flows for each route that are
separate from each other."

In this sentence, the phrase "that are separate from each other" is a
restrictive relative clause modifying "each route." However, this
construction makes the sentence slightly confusing because it seems to
imply that the separation applies to the routes themselves, not to the
data flows. The sentence structure leads to ambiguity regarding what
exactly is separate from what.

Therefore, Sentence A is clearer and more grammatically sound in the
context provided.


--
Kieran


>  other. Any number of routes from streams on sink pads towards streams on
>  source pads is allowed, to the extent supported by drivers. For every
>  stream on a source pad, however, only a single route is allowed.
> -- 
> 2.44.0
>
diff mbox series

Patch

diff --git a/Documentation/userspace-api/media/v4l/dev-subdev.rst b/Documentation/userspace-api/media/v4l/dev-subdev.rst
index 43988516acdd..7f6620cbdf78 100644
--- a/Documentation/userspace-api/media/v4l/dev-subdev.rst
+++ b/Documentation/userspace-api/media/v4l/dev-subdev.rst
@@ -561,7 +561,7 @@  selections. The order of configuring formats and selections along a stream is
 the same as without streams (see :ref:`format-propagation`).
 
 Instead of the sub-device wide merging of streams from all sink pads
-towards all source pads, data flows for each route are separate from each
+towards all source pads, data flows for each route that are separate from each
 other. Any number of routes from streams on sink pads towards streams on
 source pads is allowed, to the extent supported by drivers. For every
 stream on a source pad, however, only a single route is allowed.