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

remove the Document element from Edm lib #1159

Merged
merged 1 commit into from
May 4, 2018

Conversation

xuzhg
Copy link
Member

@xuzhg xuzhg commented May 2, 2018

Issues

Description

OData V3 spec has:

2.3 The edm:Documentation Element
The edm:Documentation element allows service authors to provide documentation for most model elements.
A model element MUST NOT contain more than one documentation element.
Refer to the [XML schema][csdl19] for details on which model elements support documentation.
A documentation element MUST contain zero or one edm:Summary and zero or one edm:LongDescription elements. The summary and long description elements MAY contain text that serves as the summary or long description. If both a summary and long description are provided, the summary MUST precede the long description.
For example:

<EntityType Name="Product"> 
 <Documentation>
  <Summary>Product names, suppliers, prices, and units in stock.</Summary>
  <LongDescription>...</LongDescription>
 </Documentation>
 ...
</EntityType>

However, that's not in OData Spec v4.

This PR is trying to remove the corresponding codes.

Checklist (Uncheck if it is not completed)

  • Test cases added
  • Build and test with one-click build and test script passed

Additional work necessary

If documentation update is needed, please add "Docs Needed" label to the issue and provide details about the required document change in the issue.

Copy link
Member

@mikepizzo mikepizzo left a comment

Choose a reason for hiding this comment

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

Just to confirm; this is just code clean-up with no change to public surface area, right? I didn't see any change to public classes or to the api baseline file, but I just wanted to verify.

@xuzhg xuzhg merged commit 86c6f17 into OData:master May 4, 2018
@xuzhg
Copy link
Member Author

xuzhg commented May 4, 2018

@mikepizzo Yes.

@xuzhg xuzhg deleted the RemoveEdmDocumentation branch January 2, 2019 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants