Documentation about Fast-CDR v2.0.0 and new annotations [19458]#550
Merged
JLBuenoLopez merged 12 commits intomasterfrom Sep 27, 2023
Merged
Documentation about Fast-CDR v2.0.0 and new annotations [19458]#550JLBuenoLopez merged 12 commits intomasterfrom
JLBuenoLopez merged 12 commits intomasterfrom
Conversation
893e770 to
e8127b7
Compare
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
ea23529 to
51d83d8
Compare
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
9 tasks
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
JLBuenoLopez
suggested changes
Sep 20, 2023
Contributor
There was a problem hiding this comment.
I am missing the following information:
- The usage section should include the new argument
-de | --default_extensibility. - A note clarifying in Zero copy constraints stating that only FINAL types are considered to be plain (an a reference to the extensibility section).
- New header files and constants should be included into the API reference:
- eprosima::fastcdr::CdrVersion DEFAULT_XCDR_VERSION
- DataRepresentationId_t DEFAULT_DATA_REPRESENTATION
- Fast DDS Docs manual CI should be updated to use CMake 3.22. Probably the nightly job should also be updated.
- Example CMakeList should use CMake minimum version 3.22.
- The getting started application section explains the files generated by Fast DDS-Gen. It should be updated with the two new generated files.
- The previous point also applies to the Python application
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
Member
Author
Done in 100644 |
JLBuenoLopez
suggested changes
Sep 21, 2023
Contributor
JLBuenoLopez
left a comment
There was a problem hiding this comment.
CI is using fastrtps.repos from master and not the given branch. Once eProsima/Fast-DDS#3828 is merged we should run another CI
docs/fastdds/getting_started/simple_python_app/includes/dataType.rst
Outdated
Show resolved
Hide resolved
Contributor
|
The CI results can be found in this job The following warnings are being displayed: Also the doc8 tests complains about: Finally, the spell check is also failing (though I think that it can be the same error as the doc8) |
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.