Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PDU documentation #51

Closed
mdabrowski1990 opened this issue Aug 15, 2021 · 1 comment · Fixed by #56
Closed

PDU documentation #51

mdabrowski1990 opened this issue Aug 15, 2021 · 1 comment · Fixed by #56
Assignees
@mdabrowski1990
Labels
documentation Improvements or additions to documentation
Projects
UDS
Milestone
1) Basic function...

Comments

@mdabrowski1990
Copy link
Owner

mdabrowski1990 commented Aug 15, 2021 •
edited
Loading

Description

As a user, I would like to have documentation of existing PDU implementation, so I know how to use it and what it is for.
As a user, I would like to have knowledge base of UDS, so I have explanation of UDS terminology and I could understand what is going on even if I am not an UDS expert.

Acceptance Criteria

ReadTheDocs documentation is udpated, sucessfully builds and has following changes:

  • PDU implementation is documented:
    • AbstractPCI, AbstractPDU and AbstractPDURecord classes
    • TransmissionDirection and Addressing enums
  • New chapter UDS Knowledge Base is created and contains information about:
    • N_PDU
    • N_PCI
    • Addressing
@mdabrowski1990 mdabrowski1990 added the documentation Improvements or additions to documentation label Aug 15, 2021
@mdabrowski1990 mdabrowski1990 added this to New in UDS via automation Aug 15, 2021
@mdabrowski1990
Copy link
Owner Author

Spawned by #46

@mdabrowski1990 mdabrowski1990 moved this from New to Defined in UDS Aug 15, 2021
@mdabrowski1990 mdabrowski1990 self-assigned this Aug 16, 2021
@mdabrowski1990 mdabrowski1990 moved this from Defined to In progress in UDS Aug 16, 2021
@mdabrowski1990 mdabrowski1990 linked a pull request Aug 17, 2021 that will close this issue
N_PDU documentation #56
Merged
@mdabrowski1990 mdabrowski1990 moved this from In progress to Review in progress in UDS Aug 17, 2021
UDS automation moved this from Review in progress to Done Aug 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mdabrowski1990 mdabrowski1990

Labels
documentation Improvements or additions to documentation
Projects
No open projects
UDS
  
Done
Milestone
1) Basic functionality
Development

Successfully merging a pull request may close this issue.

N_PDU documentation mdabrowski1990/uds
1 participant
@mdabrowski1990