-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
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
[cpp][qt] Start cleanup of cpp qt readme #10549
Conversation
Indeed. After a quick look here are some suggestion:
|
Sounds good, I think this is a better sane starting point now :) |
The links in the following paragraph are dead:
I would suggest to remove the link since there is specific generators for the documentation. |
@@ -197,7 +148,6 @@ servers: | |||
- url: https://localhost:8080/v1 | |||
``` | |||
|
|||
|
|||
## Documentation for Authorization | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MartinDelille I think this section could be removed too?
"## Documentation for Authorization"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should keep it to show users whether this API requires authorisation or not.
LGTM |
cc @ravinikam (2017/07) @stkrwork (2017/07) @etherealjoy (2018/02) @MartinDelille (2018/03) @muttleyxd (2019/08) |
Unless I am severely confused... this readme needs some love, so just starting a little bit of the no brainer cleanup.
@etherealjoy @MartinDelille
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*
.For Windows users, please run the script in Git BASH.
master
(5.3.0),6.0.x