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.

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

Improve readability of API Errors, Metadata and Types definitions in docs #733

Merged
merged 4 commits into from
Jun 7, 2022
Merged

Improve readability of API Errors, Metadata and Types definitions in docs #733

merged 4 commits into from
Jun 7, 2022

Conversation

kriswest
Copy link
Contributor

@kriswest kriswest commented May 27, 2022 •
edited
Loading

Improve readability of API Errors, Metadata and Types definitions in docs by limiting line lengths to 80 chars (lines don't wrap in code blocks so you had to scroll to read) and adding a blank line between definitions

Before:

After:

@kriswest
Improve readability of API Errors, Metadata and Types definitions by …
49eac4b 
…limiting line lengths to 80 chars and adding a blank line between definitions
@kriswest kriswest added the docs Documentation label May 27, 2022
@kriswest kriswest added this to the 2.0 milestone May 27, 2022
@kriswest kriswest requested a review from hughtroeger May 27, 2022 11:05
@netlify
Copy link

netlify bot commented May 27, 2022 •
edited
Loading

✅ Deploy Preview for lambent-kulfi-cf51a7 canceled.

Name Link
🔨 Latest commit dfe43c1
🔍 Latest deploy log https://app.netlify.com/sites/lambent-kulfi-cf51a7/deploys/6294b89356418d000815b5c7

kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Errors.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Metadata.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Types.md Outdated Show resolved Hide resolved
kriswest
kriswest commented May 30, 2022
View reviewed changes
docs/api/ref/Types.md Outdated Show resolved Hide resolved
robmoffat
robmoffat approved these changes Jun 7, 2022
View reviewed changes
Copy link
Member

@robmoffat robmoffat left a comment

Choose a reason for hiding this comment

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

Looks fine to me

@kriswest kriswest merged commit a6d09ef into master Jun 7, 2022
@kriswest kriswest deleted the format-api-docs-comments branch November 13, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hughtroeger hughtroeger hughtroeger approved these changes

@rikoe rikoe rikoe approved these changes

@robmoffat robmoffat robmoffat approved these changes

Assignees
No one assigned
Labels
docs Documentation
Projects
None yet
Milestone
2.0
Development

Successfully merging this pull request may close these issues.
4 participants
@kriswest @robmoffat @rikoe @hughtroeger