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

Added private scope for loadSVGNavigationIcons method (emoji plugin) #3978

Merged
merged 1 commit into from
Apr 10, 2020

Conversation

hub33k
Copy link
Contributor

@hub33k hub33k commented Apr 8, 2020

What is the purpose of this pull request?

Bug fix

Does your PR contain necessary tests?

All patches that change the editor code must include tests. You can always read more
on PR testing,
how to set the testing environment and
how to create tests
in the official CKEditor documentation.

This PR contains

  • Unit tests
  • Manual tests

Did you follow the CKEditor 4 code style guide?

Your code should follow the guidelines from the CKEditor 4 code style guide which helps keep the entire codebase consistent.

  • PR is consistent with the code style guide

What is the proposed changelog entry for this pull request?

*[#3951](https://github.com/ckeditor/ckeditor4/issues/3951): Added private scope for loadSVGNavigationIcons method (emoji plugin).

What changes did you make?

Added private scope for loadSVGNavigationIcons method (emoji plugin)

Which issues does your PR resolve?

Closes #3951.

@hub33k hub33k requested a review from f1ames April 8, 2020 14:55
Copy link
Contributor

@f1ames f1ames left a comment

Choose a reason for hiding this comment

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

Have you checked if documentation now builds correctly? From what I see there is still a warning about global method during build:

And it is still showed as global, just private one:

Instead of a @private property, you need a correct @member namespace, like for example in codesnippet plugin. Please also check if everythink works fine after the changes by building documentation locally.

@f1ames
Copy link
Contributor

f1ames commented Apr 9, 2020

Looking at it again, it seems to be more subtle issue. This method is not exposed anywhere and we just doesn't document such methods usually. One can get EmojiPanel via CKEDITOR.ui.get, but still we don't have any docs for it, so having one method documented doesn't look good.

I would just change the comment from /** to // so it is not parsed/processed by JSDuck during docs building.

@hub33k hub33k force-pushed the t/3951 branch 2 times, most recently from cd3b820 to a214729 Compare April 9, 2020 11:20
Copy link
Contributor

@f1ames f1ames left a comment

Choose a reason for hiding this comment

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

👍

@f1ames
Copy link
Contributor

f1ames commented Apr 10, 2020

We'll skip changelog entry here since it's not a bug fix nor an API change.

@f1ames f1ames merged commit 227e1cc into master Apr 10, 2020
@CKEditorBot CKEditorBot deleted the t/3951 branch April 10, 2020 08:21
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