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

docs: Fix table in section "GET /api/v1.0/config" #2712

Merged
merged 1 commit into from
Jan 8, 2021

Conversation

das-g
Copy link
Contributor

@das-g das-g commented Jan 7, 2021

  • Resolves: (I didn't file an issue about the docs rendering problem fixed here. Should I?)
  • Target version: master

Summary

If the number of columns doesn't agree between the rows, the MarkDown table markup seems to be broken and rendered incorrectly in both, the GitHub preview and on https://deck.readthedocs.io. This change fixes this for the table at https://deck.readthedocs.io/en/latest/API/#config, by removing a field in the title row that didn't have corresponding fields in the other rows of the table.

TODO

(I'm unaware of anything left to do about this.)

  • ...

Checklist

  • Code is properly formatted
    • (Are there guidelines on how to format MarkDown for the manual?)
  • Sign-off message is added to all commits
  • Tests (unit, integration, api and/or acceptance) are included
    • (Not really applicable here, I guess.)
  • Documentation (manuals or wiki) has been updated or is not required
    • (This is a documentation-only change.)

If the number of columns doesn't agree between the rows,
the MarkDown table markup seems to be broken
and rendered incorrectly in both, the GitHub preview
and on https://deck.readthedocs.io/en/latest/API/#config.

Signed-off-by: Raphael Borun Das Gupta <[email protected]>
Copy link
Member

@juliusknorr juliusknorr left a comment

Choose a reason for hiding this comment

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

Thanks a lot :)

@juliusknorr juliusknorr merged commit db5adfc into nextcloud:master Jan 8, 2021
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.

2 participants