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

Add short documentation for indexables #14416

Merged
merged 9 commits into from
Feb 24, 2020
Merged

Add short documentation for indexables #14416

merged 9 commits into from
Feb 24, 2020

Conversation

johannadevos
Copy link
Contributor

Summary

This PR can be summarized in the following changelog entry:

  • N/A Adds short documentation and a few other CS fixes

Relevant technical choices:

  • The @inheritDoc tag still leads to code sniff errors, this is known. I did not touch @inheritDoc.
  • Inline dock blocks are not handled correctly either by the code sniffer, again I did not touch these.

Test instructions

This PR can be tested by following these steps:

  • This PR concerns documentation only, so watching Travis pass is the only requirement.

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Documentation

  • I have written documentation for this change.

Quality assurance

  • I have tested this code to the best of my abilities
  • I have added unittests to verify the code works as intended

Fixes #14248

@johannadevos johannadevos added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Feb 24, 2020
@johannadevos johannadevos added this to the Indexables frontend milestone Feb 24, 2020
@johannadevos johannadevos merged commit ebf1811 into feature/indexables-frontend Feb 24, 2020
@johannadevos johannadevos deleted the add-short-docs-indexables branch February 24, 2020 13:40
@johannadevos johannadevos mentioned this pull request Feb 24, 2020
Closed
@IreneStr IreneStr added the innovation Innovative issue. Relating to performance, memory or data-flow. label Mar 20, 2020
@IreneStr IreneStr modified the milestones: Indexables frontend, 14.0 Apr 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog innovation Innovative issue. Relating to performance, memory or data-flow.
Projects
None yet
Milestone
14.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@johannadevos @IreneStr @hansjovis