[Azure Search] Adding missing documentation and test coverage #4601
Conversation
This file contains 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
Some of our custom code was missing XML documentation, partly because we didn't realize that the publishing system for docs.microsoft.com does not support <inheritdoc/>. These changes were originally applied on the search-preview branch and are being re-applied here.
Somehow a test stopped working in playback mode, possibly due to changes in how TestFramework handles generated names. This was easily fixed by re-recording the session record for the test.
There are no code changes in this release, but there are doc changes and we'd rather ship them now than wait for the next set of code changes.
|
@dsgouda @shahabhijeet Can one of you please take a look? These are mostly some small doc updates that we want to ship. |
dsgouda
suggested changes
Jul 30, 2018
| @@ -6,7 +6,7 @@ | |||
| <Description>Common types needed by the Azure Search .NET libraries. This is not the package you are looking for; It is only meant to be used as a dependency.</Description> | |||
| <AssemblyTitle>Microsoft Azure Search Common Library</AssemblyTitle> | |||
| <AssemblyName>Microsoft.Azure.Search.Common</AssemblyName> | |||
| <VersionPrefix>5.0.1</VersionPrefix> | |||
There was a problem hiding this comment.
We recommend using AssemblyVersion instead of VersionPrefix
@shahabhijeet FYI
|
@dsgouda I assume you mean |
|
@brjohnstmsft That's right, apologize for the confusion |
dsgouda
approved these changes
Jul 31, 2018
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.
Description
See individual commits for details.
FYI @mhko @Yahnoosh @updixit @natinimni @jeji1101 @HeidiSteen
This checklist is used to make sure that common guidelines for a pull request are followed.
General Guidelines
Testing Guidelines
SDK Generation Guidelines
*.csprojandAssemblyInfo.csfiles have been updated with the new version of the SDK.