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

fix a formatting issue with api docs #572

Merged
merged 1 commit into from Oct 6, 2015
Merged

fix a formatting issue with api docs #572

merged 1 commit into from Oct 6, 2015

Conversation

ghost
Copy link

@ghost ghost commented Oct 5, 2015

Prior to this commit, there was a Markdown formatting problem with the
API docs. This resulted in a bunch of (what should have been) bullet
points appearing as normal text, and making the explanation of the ISO
8601 format harder to read than it needed to be.

This commit modifies some of the API documentation to correctly format
the bullet list for the "Adding a Scheduled Job" section.

@ghost
Copy link
Author

ghost commented Oct 5, 2015

Also note that this wasn't an issue with GitHub-flavored Markdown (i.e. viewing the docs in the repo), but that the API docs weren't formatted correctly on the Jekyll-generated site used for GitHub Pages. It should now be appearing correctly in both places (also tested locally using jekyll serve).

Prior to this commit, there was a Markdown formatting problem with the
API docs. This resulted in a bunch of (what should have been) bullet
points appearing as normal text, and making the explanation of the ISO
8601 format harder to read than it needed to be.

This commit modifies some of the API documentation to correctly format
the bullet list for the "Adding a Scheduled Job" section.
@gkleiman
Copy link
Member

gkleiman commented Oct 6, 2015

Thank you for the PR!

gkleiman added a commit that referenced this pull request Oct 6, 2015
fix a formatting issue with api docs
@gkleiman gkleiman merged commit 67b6097 into mesos:master Oct 6, 2015
@ghost ghost deleted the fix-api-docs-formatting branch October 6, 2015 20:30
@ghost
Copy link
Author

ghost commented Oct 6, 2015

Sure thing, @gkleiman! It looks like master needs to be synced with the gh-pages branch too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant