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

Add HTML Documentation API #1758

Merged
merged 8 commits into from
Jun 1, 2021
Merged

Add HTML Documentation API #1758

merged 8 commits into from
Jun 1, 2021

Conversation

4e6
Copy link
Contributor

@4e6 4e6 commented May 26, 2021

Pull Request Description

close #1698

PR adds support for the HTML documentation chunks. HTML chunks are stored in the documentation_html column of the suggestions table. New suggestions_order table allows preserving the order of chunks in the source file.

Note. documentation_html probably makes the documentation column containing the raw docstring obsolete. We may remove it in future releases but will keep it for backward compatibility for now.

Changelog:

  • add: documentation_html column to suggestions database
  • add: suggestions_order table that stores the order of the module-level entries in the source file
  • add: JSON API supporting the updates of the suggestions_order table

Important Notes

Checklist

Please include the following checklist in your PR:

  • The documentation has been updated if necessary.
  • All code conforms to the Scala, Java, and Rust style guides.
  • All documentation and configuration conforms to the markdown and YAML style guides.
  • All code has been tested where possible.

@4e6 4e6 added Type: Enhancement p-high Should be completed in the next sprint w-docs Website: Documentation labels May 26, 2021
@4e6 4e6 self-assigned this May 26, 2021
@4e6 4e6 requested review from iamrecursion and kustosz as code owners May 26, 2021 14:31
@4e6 4e6 requested a review from radeusgd May 26, 2021 14:56
@4e6 4e6 force-pushed the wip/db/documentation-chunk-api branch from fb66a59 to 8bfaf44 Compare May 28, 2021 10:45
@4e6 4e6 merged commit d67f7a2 into main Jun 1, 2021
@4e6 4e6 deleted the wip/db/documentation-chunk-api branch June 1, 2021 12:43
iamrecursion pushed a commit that referenced this pull request Jun 24, 2021
Add support for the HTML documentation chunks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p-high Should be completed in the next sprint w-docs Website: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Design Suggestions Database Schema and API for Documentation Chunks
2 participants