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.

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

Fixed generator history/deprecated documentation #1766

Conversation

FrankElias77
Copy link
Contributor

Fixes #1761

Risk

This PR makes no API changes.

Testing Plan

  • I have verified that I have not introduced new warnings in this PR (or explain why below)
  • I have run the unit tests with this PR
  • I have tested this PR against Core and verified behavior (if applicable, if not applicable, explain why below).

Unit Tests

Generator only changes.

Core Tests

Generator only changes.

Core version / branch / commit hash / module tested against: N/A
HMI name / version / branch / commit hash / module tested against: N/A

Summary

Fixed the since label referring to deprecated instead of to when the rpc was added.

Changelog

Breaking Changes
  • N/A
Enhancements
  • N/A
Bug Fixes
  • Fixed the generator since label to when rpc was deprecated instead to when an rpc is added

Tasks Remaining:

  • N/A

CLA

@FrankElias77 FrankElias77 added bug A defect in the library rpc-spec-generator Relating to the RPC spec generator labels Sep 2, 2020
@FrankElias77 FrankElias77 self-assigned this Sep 2, 2020
@FrankElias77 FrankElias77 changed the title Bugfix/issue 1761 updating history deprecated documentation Fixed generator history/deprecated documentation Sep 2, 2020
@codecov
Copy link

codecov bot commented Sep 2, 2020

Codecov Report

Merging #1766 into develop will increase coverage by 0.34%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #1766      +/-   ##
===========================================
+ Coverage    82.68%   83.03%   +0.34%     
===========================================
  Files          419      420       +1     
  Lines        21507    22037     +530     
===========================================
+ Hits         17784    18298     +514     
- Misses        3723     3739      +16     

Copy link
Contributor

@NicoleYarroch NicoleYarroch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small fix requested.

{%- if since %}
* @since SDL {{ since }}
{%- if deprecated is sameas true and history %}
* @added in SmartDeviceLink {{ history[0].since }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The history[0].since value does not appear to get printed here if a struct or enum was deprecated.

Reproduce

In SDLDisplayType I see:

 * @deprecated in SmartDeviceLink 5.0.0
 * @added in SmartDeviceLink 

1.0.0 is missing after @added in SmartDeviceLink

This is the RPC spec entry for DisplayType:

<enum name="DisplayType" deprecated="true" since="5.0">
    <description>See DAES for further infos regarding the displays</description>
    <element name="CID"/>
    <element name="TYPE2" />
    <element name="TYPE5" />
    <element name="NGN" />
    <element name="GEN2_8_DMA" since="3.0" />
    <element name="GEN2_6_DMA" since="3.0" />
    <element name="MFD3" since="2.0" />
    <element name="MFD4" since="2.0" />
    <element name="MFD5" since="2.0" />
    <element name="GEN3_8-INCH" internal_name="GEN3_8_INCH" since="3.0" />
    <element name="SDL_GENERIC" since="4.0" />
    <history>
        <enum name="DisplayType" since="1.0" until="5.0"/>
    </history>
</enum>

add history/deprecated documentation in enum
@joeljfischer joeljfischer merged commit d927360 into develop Sep 17, 2020
@joeljfischer joeljfischer deleted the bugfix/issue-1761-updating-history-deprecated-documentation branch September 17, 2020 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A defect in the library rpc-spec-generator Relating to the RPC spec generator
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants