Skip to content

azure-core JavaDocs and code snippet clean-up #5653

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
Merged
conniey merged 13 commits into from
Oct 4, 2019
Merged

azure-core JavaDocs and code snippet clean-up #5653

conniey merged 13 commits into from
Oct 4, 2019

Conversation

@conniey
Copy link
Member

@conniey conniey commented Oct 2, 2019 •
edited
Loading

  • Fixes small errors in azure-core's polling, logging, and tracing documentation.
    • Use sentence casing for headers.
    • Add periods to end sentences.
  • Updates Poller samples to be more reactive and less synchronous.
  • Moves ClientLogger java doc samples from implementation.util into util.logging to match class.

Related to: #3752

@conniey conniey added Client This issue points to a problem in the data-plane of the library. Azure.Core azure-core common common module used by all azure SDKs (e.g. client, Mgmt) labels Oct 2, 2019
@conniey conniey self-assigned this Oct 2, 2019
@conniey conniey requested a review from JonathanGiles October 2, 2019 14:46
@conniey conniey requested a review from samvaity October 2, 2019 14:53
@conniey
Copy link
Member Author

conniey commented Oct 2, 2019

@samvaity I believe this conflicts with some of your Tracer documentation changes. Let me know when your PR is merged and I will resolve conflicts.

@conniey conniey merged commit 3de3bbc into Azure:master Oct 4, 2019
@conniey conniey deleted the cleanup-docs branch October 4, 2019 19:11
chrischild pushed a commit to chrischild/azure-sdk-for-java that referenced this pull request Oct 5, 2019
@conniey
azure-core JavaDocs and code snippet clean-up (Azure#5653)
5cc9153 
* Updating comments in package-info.java.

* Update documentation in Tracer and TracerProxy.

* Add doc updates to Poller.

* Making code snippets more reactor-ish.

* Fix naming.

* Fix typos.

* Move ClientLogger java doc samples to correct location.

* Update documentation in ClientLogger.

* Fix codesnippet references.

* Update package-info.java

* Update parameter docs.
@joshfree joshfree mentioned this pull request Nov 5, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alzimmermsft alzimmermsft alzimmermsft approved these changes

@hemanttanwar hemanttanwar Awaiting requested review from hemanttanwar

@jianghaolu jianghaolu Awaiting requested review from jianghaolu

@srnagar srnagar Awaiting requested review from srnagar

@JonathanGiles JonathanGiles Awaiting requested review from JonathanGiles

@samvaity samvaity Awaiting requested review from samvaity

Assignees

@conniey conniey

Labels

Azure.Core azure-core Client This issue points to a problem in the data-plane of the library. common common module used by all azure SDKs (e.g. client, Mgmt)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@conniey @alzimmermsft