Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs: applications and authorization#5477

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
mtojek merged 15 commits intocoder:mainfrommtojek:3522-document-more-methods
Dec 21, 2022

Conversation

mtojek
Copy link
Member

@mtojekmtojek commentedDec 20, 2022•
edited
Loading

Related:#3522

Changes:

  • Documented:Applications,Authorization
  • Fix: missing description for structures (fixed with@Description)
  • Fix: replace@Consume with@Accept

Question:
* What quality level of documentation do we want to achieve? (description:none vs.DisplayName is the displayed name) Fix:s/none//g

@mtojekmtojek self-assigned thisDec 20, 2022
@mtojekmtojek changed the title3522 document more methodsdocs: applications and authorizationDec 20, 2022
@mtojekmtojek marked this pull request as ready for reviewDecember 20, 2022 19:13
Copy link
Member

@mafredrimafredri left a comment

Choose a reason for hiding this comment

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

  • What quality level of documentation do we want to achieve? (description:none vs.DisplayName is the displayed name)

Instead ofnone, we could omit the text entirely (empty). I think it's fine not to document all obvious things for now. But ultimately I'd like for us to have very good coverage incodersdk/API docs with explanations for most fields.

mtojek reacted with thumbs up emoji
@mtojek
Copy link
MemberAuthor

Thanks for the review,@mafredri! All comments addressed. It's interesting that we can continuously improve the rendering procedure to achieve better results!

Copy link
Member

@mafredrimafredri left a comment

Choose a reason for hiding this comment

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

Nice work!

It's interesting that we can continuously improve the rendering procedure to achieve better results!

I agree! It's nice to have bite-sized pieces, easier to catch oddities. 😄

mtojek reacted with thumbs up emoji
@mtojekmtojek merged commit2bbeff5 intocoder:mainDec 21, 2022
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsDec 21, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@mafredrimafredrimafredri approved these changes

@bpmctbpmctAwaiting requested review from bpmct

Assignees

@mtojekmtojek

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@mtojek@mafredri
[8]ページ先頭
©2009-2025 Movatter.jp