search

wxWidgets / Phoenix

wxPython's Project Phoenix. A new implementation of wxPython, better, stronger, faster than he was before.
http://wxpython.org/
2.29k stars 516 forks source link

error in doc conversion #1089

Open ousia opened 5 years ago

ousia commented 5 years ago

[Already reported in wxWidgets/wxPython#29. @swt2c asked me to report it here.]

https://wxpython.org/Phoenix/docs/html/wx.TopLevelWindow.html#wx.TopLevelWindow.ShowFullScreen contains:

Showing a window full screen also actually Show s the window if it isn’t shown.

In any case, it must read:

Showing a window full screen also actually shows the window if it isn’t shown.

But a better wording could be:

A window is only set in full screen mode if it wasn’t in that state before.

Just an idea, I think “show” should be avoided in that sentence.

BTW, I tried to provide a PR, but I couldn’t find which is the file that contains the error.

The error is also repeated in the development version.

infinity77 commented 5 years ago

You could t find it because the documentation is automatically generated from the wxWidgets one:

https://docs.wxwidgets.org/trunk/classwx_top_level_window.html#ab4089f1274bcb74e5f7763d1fb84ee28

So you may want to redirect this enhancement proposal to wxWidgets.

swt2c commented 5 years ago

My bad, I should have noticed that.

So this is the ultimate source for that message: https://github.com/wxWidgets/wxWidgets/blob/WX_3_0_BRANCH/interface/wx/toplevel.h#L553

It looks like actually this may be some sort of parsing error, as in the wxWidgets documentation, it looks different: https://docs.wxwidgets.org/3.0/classwx_top_level_window.html#ab4089f1274bcb74e5f7763d1fb84ee28