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

THRIFT-5164: Small cleanup on the example code #2128

Merged
merged 1 commit into from May 1, 2020

Conversation

fishy
Copy link
Member

@fishy fishy commented Apr 30, 2020

Client: go

Godoc requires at least one other exported type/function to render the
whole example file in the example, so export
simpleProcessorLoggingMiddleware to make the example of
ProcessorMiddleware more helpful.

Currently it's rendered in a not very helpful way:
https://pkg.go.dev/github.com/apache/thrift@v0.13.1-0.20200430141240-5cffef964a08/lib/go/thrift?tab=doc#example-ProcessorMiddleware

Compare to the client middleware example rendering:
https://pkg.go.dev/github.com/apache/thrift@v0.13.1-0.20200430141240-5cffef964a08/lib/go/thrift?tab=doc#example-ClientMiddleware

While I'm here, also update CHANGES.md to mention ClientMiddleware.

  • Did you create an Apache Jira ticket? (not required for trivial changes)
  • If a ticket exists: Does your pull request title follow the pattern "THRIFT-NNNN: describe my issue"?
  • Did you squash your changes to a single commit? (not required, but preferred)
  • Did you do your best to avoid breaking changes? If one was needed, did you label the Jira ticket with "Breaking-Change"?
  • If your change does not involve any code, add [skip ci] at the end of your pull request to free up build resources.

[skip ci]

@fishy
Copy link
Member Author

fishy commented Apr 30, 2020

@dcelasun @pacejackson :)

@fishy
Copy link
Member Author

fishy commented Apr 30, 2020

[skip ci] doesn't seem to work 😬

@dcelasun
Copy link
Member

dcelasun commented Apr 30, 2020

[skip ci] doesn't seem to work 😬

I've killed the build, but there is no [skip ci] in the commit body 🙂

@fishy
Copy link
Member Author

fishy commented Apr 30, 2020

The instruction says pull request, it didn't say commit message:

add [skip ci] at the end of your pull request to free up build resources.

@dcelasun
Copy link
Member

The instruction says pull request, it didn't say commit message

Ah, that's unfortunate. Fixed by 4873068.

Client: go

Godoc requires at least one other exported type/function to render the
whole example file in the example, so export
simpleProcessorLoggingMiddleware to make the example of
ProcessorMiddleware more helpful.

Currently it's rendered in a not very helpful way:
https://pkg.go.dev/github.com/apache/thrift@v0.13.1-0.20200430141240-5cffef964a08/lib/go/thrift?tab=doc#example-ProcessorMiddleware

Compare to the client middleware example rendering:
https://pkg.go.dev/github.com/apache/thrift@v0.13.1-0.20200430141240-5cffef964a08/lib/go/thrift?tab=doc#example-ClientMiddleware

While I'm here, also update CHANGES.md to mention ClientMiddleware.

[skip ci]
@pacejackson
Copy link
Contributor

👍

@fishy
Copy link
Member Author

fishy commented Apr 30, 2020

Added [skip ci] to the commit message.

@dcelasun dcelasun merged commit 0c173bf into apache:master May 1, 2020
@fishy fishy deleted the fix-examples branch June 13, 2020 05:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants