ckeditor / ckeditor5

Powerful rich text editor framework with a modular architecture, modern integrations, and features like collaborative editing.
https://ckeditor.com/ckeditor-5
Other
9.52k stars 3.7k forks source link

Update `FontSizeOption` documentation #12822

Open Semigradsky opened 1 year ago

Semigradsky commented 1 year ago

https://ckeditor.com/docs/ckeditor5/35.2.1/api/module_font_fontsize-FontSizeOption.html

According to example in CKEditor 5 documentation (35.2.1), upcastAlso and view are optional:

const fontSizeConfig = {
    options: [
        {
            title: 'Small',
            model: '8px'
        },
        'default',
        {
            title: 'Big',
            model: '14px'
        }
    ]
};

Related ticket: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/63059

Semigradsky commented 1 year ago

As I see, upcastAlso is marked as optional https://github.com/ckeditor/ckeditor5/blob/656057f3b1e810eb088d1752952dbd99815f8ac0/packages/ckeditor5-font/src/fontsize.js#L61

But it doesn't look as optional in docs: image

Smth wrong with the documentation generator?

CKEditorBot commented 11 months ago

There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may still be relevant, so if you're interested in the solution, leave a comment or reaction under this issue.

Semigradsky commented 11 months ago

Still valid

Witoso commented 11 months ago

Looks like an invalid doc comment.