Skip to content

build(aio): add API static members to search index #21988

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

Conversation

petebacondarwin
Copy link
Contributor

@petebacondarwin petebacondarwin commented Feb 2, 2018

Previously searching for compose did not include Validators
in the search results because we were not including all the
static members in the index.

@petebacondarwin petebacondarwin added action: review The PR is still awaiting reviews from at least one requested reviewer comp: aio target: patch This PR is targeted for the next patch release labels Feb 2, 2018
expect(page.getSearchResults()).toContain('ControlValueAccessor');
});
});

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved to search.e2e-spec.ts

@@ -97,7 +97,7 @@ module.exports = function generateKeywordsProcessor(log, readFilesProcessor) {

// Special case properties that contain content relating to "members"
// of a doc that represents, say, a class or interface
if (key === 'methods' || key === 'properties' || key === 'events') {
if (key === 'members' || key === 'statics') {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These keys were originally copied over from the AngularJS project.
In reality we only have members and statics on our Angular API docs.

@mary-poppins
Copy link

You can preview 9f250ac at https://pr21988-9f250ac.ngbuilds.io/.

it('should find classes whose static method name matches the search query', () => {
page.enterSearch('compose');
expect(page.getSearchResults()).toContain('Validators');
});
Copy link
Member

Choose a reason for hiding this comment

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

Do we need a test for members too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We didn't have one before :-P

@gkalpak gkalpak added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Feb 2, 2018
@petebacondarwin petebacondarwin force-pushed the aio-search-index-static-members branch from 9f250ac to e101b42 Compare February 2, 2018 16:54
@mary-poppins
Copy link

You can preview e101b42 at https://pr21988-e101b42.ngbuilds.io/.

@petebacondarwin
Copy link
Contributor Author

Added an e2e test for instance members too.

@petebacondarwin petebacondarwin added action: merge The PR is ready for merge by the caretaker and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Feb 2, 2018
Previously searching for `compose` did not include `Validators`
in the search results because we were not including all the
`static` members of API docs in the index.
@petebacondarwin petebacondarwin force-pushed the aio-search-index-static-members branch from e101b42 to a423c0c Compare February 2, 2018 17:24
@mary-poppins
Copy link

You can preview a423c0c at https://pr21988-a423c0c.ngbuilds.io/.

@alxhub alxhub closed this in 9a0700f Feb 5, 2018
alxhub pushed a commit that referenced this pull request Feb 5, 2018
Previously searching for `compose` did not include `Validators`
in the search results because we were not including all the
`static` members of API docs in the index.

PR Close #21988
@petebacondarwin petebacondarwin deleted the aio-search-index-static-members branch February 5, 2018 22:44
gkalpak added a commit to gkalpak/angular that referenced this pull request Feb 22, 2018
The `search.e2e-spec.ts` file accidentally ended up in the wrong (old)
directory, while rebasing angular#21988.
jbogarthyde pushed a commit to jbogarthyde/angular that referenced this pull request Feb 23, 2018
Previously searching for `compose` did not include `Validators`
in the search results because we were not including all the
`static` members of API docs in the index.

PR Close angular#21988
leo6104 pushed a commit to leo6104/angular that referenced this pull request Mar 25, 2018
Previously searching for `compose` did not include `Validators`
in the search results because we were not including all the
`static` members of API docs in the index.

PR Close angular#21988
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants