Fixed various typos and unified some formats in documentation #996

juanjo4936 · 2024-12-20T10:21:23Z

Description

Fixed some typos found while reading the documentation, fixed some links to c-InstanceHandle_Unknown and unified the format for the references to the different QOS_DEFAULT options.

@Mergifyio backport 3.1.x 3.0.x 2.14.x 2.10.x 2.6.x

Contributor Checklist

Commit messages follow the project guidelines.
N/A Code snippets related to the added documentation have been provided.
Documentation tests pass locally.
Applicable backports have been included in the description.

Reviewer Checklist

The PR has a milestone assigned.
The title and description correctly express the PR's purpose.
Check contributor checklist is correct.
CI passes without warnings or errors.

Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com>

Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com>

juanlofer-eprosima

LGTM

juanlofer-eprosima · 2024-12-23T10:19:01Z

@Mergifyio backport 3.1.x 3.0.x 2.14.x 2.10.x 2.6.x

mergify · 2024-12-23T10:19:10Z

backport 3.1.x 3.0.x 2.14.x 2.10.x 2.6.x

✅ Backports have been created

#997 Fixed various typos and unified some formats in documentation (backport #996) has been created for branch 3.1.x
#998 Fixed various typos and unified some formats in documentation (backport #996) has been created for branch 3.0.x
#999 Fixed various typos and unified some formats in documentation (backport #996) has been created for branch 2.14.x
#1000 Fixed various typos and unified some formats in documentation (backport #996) has been created for branch 2.10.x but encountered conflicts
#1001 Fixed various typos and unified some formats in documentation (backport #996) has been created for branch 2.6.x but encountered conflicts

* Fix links in docu Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Unified the QOS_DEFAULT format in text Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fixed a typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Modified length of a line Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> --------- Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> (cherry picked from commit 0a46fe1)

* Fix links in docu Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Unified the QOS_DEFAULT format in text Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fixed a typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Modified length of a line Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> --------- Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> (cherry picked from commit 0a46fe1) # Conflicts: # docs/fastdds/dds_layer/publisher/dataWriter/createDataWriter.rst # docs/fastdds/dds_layer/subscriber/dataReader/createDataReader.rst

#996) (#1001) * Fixed various typos and unified some formats in documentation (#996) * Fix links in docu Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Unified the QOS_DEFAULT format in text Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fixed a typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Modified length of a line Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> --------- Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> (cherry picked from commit 0a46fe1) # Conflicts: # docs/fastdds/dds_layer/publisher/dataWriter/createDataWriter.rst # docs/fastdds/dds_layer/subscriber/dataReader/createDataReader.rst * Solved the conflicts from backport Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> --------- Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> Co-authored-by: juanjo4936 <69901369+juanjo4936@users.noreply.github.com> Co-authored-by: Juanjo Garcia <juanjosegarcia@eprosima.com>

…999) * Fix links in docu Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Unified the QOS_DEFAULT format in text Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fixed a typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Modified length of a line Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> --------- Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> (cherry picked from commit 0a46fe1) Co-authored-by: juanjo4936 <69901369+juanjo4936@users.noreply.github.com>

#996) (#1000) * Fixed various typos and unified some formats in documentation (#996) * Fix links in docu Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Unified the QOS_DEFAULT format in text Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fixed a typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Modified length of a line Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> --------- Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> (cherry picked from commit 0a46fe1) # Conflicts: # docs/fastdds/dds_layer/publisher/dataWriter/createDataWriter.rst # docs/fastdds/dds_layer/subscriber/dataReader/createDataReader.rst * Solved the conflicts from the backport Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> --------- Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> Co-authored-by: juanjo4936 <69901369+juanjo4936@users.noreply.github.com> Co-authored-by: Juanjo Garcia <juanjosegarcia@eprosima.com>

…998) * Fix links in docu Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Unified the QOS_DEFAULT format in text Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fixed a typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Modified length of a line Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> --------- Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> (cherry picked from commit 0a46fe1) Co-authored-by: juanjo4936 <69901369+juanjo4936@users.noreply.github.com>

…997) * Fix links in docu Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Unified the QOS_DEFAULT format in text Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fix Typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Fixed a typo Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> * Modified length of a line Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> --------- Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com> Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com> (cherry picked from commit 0a46fe1) Co-authored-by: juanjo4936 <69901369+juanjo4936@users.noreply.github.com>

Fix links in docu

59b4d09

Signed-off-by: Juanjo Garcia <juanjosegarciaesteban@gmail.com>

juanjo4936 added the ci-pending label Dec 20, 2024

juanjo4936 added this to the v3.2.0 milestone Dec 20, 2024

juanjo4936 self-assigned this Dec 20, 2024

juanjo4936 and others added 3 commits December 20, 2024 11:57

Fix Typo

8b277c0

Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com>

Unified the QOS_DEFAULT format in text

c6ef20e

Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com>

Fix Typo

5d5dd2c

Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com>

juanjo4936 force-pushed the fix/juanjo branch from dab5a4d to 5d5dd2c Compare December 20, 2024 11:23

EugenioCollado requested a review from richiprosima December 20, 2024 11:55

Fixed a typo

08f9e48

Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com>

juanjo4936 requested review from richiprosima and removed request for richiprosima December 23, 2024 07:40

Modified length of a line

afb18c3

Signed-off-by: Juanjo Garcia <juanjosegarcia@eprosima.com>

juanjo4936 requested review from richiprosima and removed request for richiprosima December 23, 2024 09:53

juanlofer-eprosima approved these changes Dec 23, 2024

View reviewed changes

juanlofer-eprosima merged commit 0a46fe1 into master Dec 23, 2024
4 checks passed

juanlofer-eprosima deleted the fix/juanjo branch December 23, 2024 10:18

mergify bot mentioned this pull request Dec 23, 2024

Fixed various typos and unified some formats in documentation (backport #996) #997

Merged

7 tasks

This was referenced Dec 23, 2024

Fixed various typos and unified some formats in documentation (backport #996) #998

Merged

Fixed various typos and unified some formats in documentation (backport #996) #999

Merged

juanlofer-eprosima removed the request for review from richiprosima December 23, 2024 10:19

mergify bot mentioned this pull request Dec 23, 2024

Fixed various typos and unified some formats in documentation (backport #996) #1000

Merged

7 tasks

mergify bot mentioned this pull request Dec 23, 2024

Fixed various typos and unified some formats in documentation (backport #996) #1001

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed various typos and unified some formats in documentation #996

Fixed various typos and unified some formats in documentation #996

juanjo4936 commented Dec 20, 2024 •

edited

Loading

juanlofer-eprosima left a comment

juanlofer-eprosima commented Dec 23, 2024 •

edited

Loading

mergify bot commented Dec 23, 2024 •

edited

Loading

Fixed various typos and unified some formats in documentation #996

Fixed various typos and unified some formats in documentation #996

Conversation

juanjo4936 commented Dec 20, 2024 • edited Loading

Description

Contributor Checklist

Reviewer Checklist

juanlofer-eprosima left a comment

Choose a reason for hiding this comment

juanlofer-eprosima commented Dec 23, 2024 • edited Loading

mergify bot commented Dec 23, 2024 • edited Loading

✅ Backports have been created

juanjo4936 commented Dec 20, 2024 •

edited

Loading

juanlofer-eprosima commented Dec 23, 2024 •

edited

Loading

mergify bot commented Dec 23, 2024 •

edited

Loading