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

API docs fixes #4090

Merged
merged 2 commits into from
Jun 4, 2020
Merged

API docs fixes #4090

merged 2 commits into from
Jun 4, 2020

Conversation

f1ames
Copy link
Contributor

@f1ames f1ames commented Jun 1, 2020

What is the purpose of this pull request?

Docs

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?

Not needed.

What changes did you make?

I created one PR to fix two API docs issues since these changes are really small. As for outdated unicode.org links see #4069 (comment).

Which issues does your PR resolve?

Closes #4062.
Closes #4069.

@Dumluregn Dumluregn self-assigned this Jun 4, 2020
@Dumluregn Dumluregn self-requested a review June 4, 2020 09:15
Copy link
Contributor

@Dumluregn Dumluregn left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Comment on lines +1056 to +1057
* * [`\u202A`](https://www.unicode.org/charts/PDF/U2000.pdf) – for Right-To-Left,
* * [`\u202B`](https://www.unicode.org/charts/PDF/U2000.pdf) – for Left-To-Right.
Copy link
Contributor

Choose a reason for hiding this comment

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

PDF references aren't cool as they are not very specific (you still need to find the interesting part). But in this case I'm afraid we don't have a better option - I did find references on some different websites (like https://charbase.com/202a-unicode-left-to-right-embedding or https://www.fileformat.info/info/unicode/char/202a/index.htm), but none of them has any connection to Unicode so they may shut down any moment and we will run into the same issue again. Still, with the proposed solution we are vulnerable to the simple change of filename 🙈 But let's hope Unicode forgets about this file and never changes it 😄

@Dumluregn
Copy link
Contributor

Travis is failing because of #4084.

@Dumluregn Dumluregn merged commit c3fd42d into master Jun 4, 2020
@Dumluregn Dumluregn deleted the t/apidocs-fixes branch June 4, 2020 10:26
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