Suggestions on documentation improvements

Share your ideas as to how the documentation can be improved.
guest3456
Posts: 3053
Joined: 09 Oct 2013, 10:31

Re: Suggestions on documentation improvements

25 Dec 2019, 01:00

nnnik wrote:
24 Dec 2019, 10:35
lexikos removed the issues tab from the AutoHotkey repository since "github is not the place to discuss changes to AutoHotkey".
Additionally it would be impossible for some to make PRs.
Also you should ever only make a PR after you got the opinion of some other people. The forum is the place to get feedback.
"Issues" on github is for discussion of changes. Lexikos has disabled the "Issues" feature for the AHK_L codebase repo only. The "Issues" tab is available for the docs repo.

"PRs" can also be for discussion, but you've also done the work to make the required changes yourself, meaning that IF the changes are acceptable, all he has to do is click one button and the suggestion for doc improvements is done.

User avatar
nnnik
Posts: 4419
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Suggestions on documentation improvements

25 Dec 2019, 04:55

A suggestion that has seen change after being discussed here is much more valueable. You should also only make a PR for a suggestion here once you got some positive feedback.

I would prefer it if lexikos always shuts down direct PRs.
Recommends AHK Studio
User avatar
nnnik
Posts: 4419
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Suggestions on documentation improvements

26 Dec 2019, 03:06

Since the staff agreed with the proposal I have now created the new subforum.
Recommends AHK Studio
joefiesta
Posts: 350
Joined: 24 Jan 2016, 13:54
Location: Pa., USA

Less than perfect example

06 Jan 2020, 14:59

At the doc for GUI ADD, PICTURE, https://www.autohotkey.com/docs/commands/GuiControls.htm#Picture, appears the following example:

; Specify below the path to the GIF file to animate (local files are allowed too):
pic := "http://www.animatedgif.net/cartoons/A_5odie_e0.gif"
Gui, Add, ActiveX, w100 h150, % "mshtml:<img src='" pic "' />"
Gui, Show


This is less than perfect. If the fileid includes an apostrophe--a certainly valid character for use in a fileid--it does not work. The Guid Add command should be coded:

Gui, Add, ActiveX, w900 h650, % "mshtml:<img src=""" pic """ />"

My suspicion is that an investigation may easily find other examples of this coding oversight in the doc.
swagfag
Posts: 3312
Joined: 11 Jan 2017, 17:59

Re: Suggestions on documentation improvements

06 Jan 2020, 15:13

not an oversight. with ur "fix", if the filename now contains double-quotes instead, it still wouldnt work. ud have to escape them either way, so obey the html escaping rules when u write html. this has nothing to do with ahk
also u can now make standalone threads in the new dedicated subforum for doc improvements
Last edited by swagfag on 06 Jan 2020, 15:34, edited 1 time in total.
joefiesta
Posts: 350
Joined: 24 Jan 2016, 13:54
Location: Pa., USA

Re: Suggestions on documentation improvements

06 Jan 2020, 15:18

@swagfag I beg to differ. A double quote is NOT A VALID WINDOWS FILEID CHARACTER. (I suspect this true for DOS as well.)

And, yes, I just saw that the new Doc suggestions forum is available.

I would like to suggest this TOPIC then be LOCKED. It would also be nice if the entire community were advised of this new forum with a mass mailing.
swagfag
Posts: 3312
Joined: 11 Jan 2017, 17:59

Re: Suggestions on documentation improvements

06 Jan 2020, 15:34

then ure right
User avatar
nnnik
Posts: 4419
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Suggestions on documentation improvements

07 Jan 2020, 03:32

We don't really have to make people aware of it via mass mailing. Everyone that was intetested/following that topic should have found out that the new forums are available.
I didn't want to lock the topic so people can respond to the last post I made.
Still Ill lock the forums now since people seem to not like reading that much.
Recommends AHK Studio
User avatar
joedf
Posts: 7455
Joined: 29 Sep 2013, 17:08
Facebook: J0EDF
Google: +joedf
GitHub: joedf
Location: Canada
Contact:

Re: Suggestions on documentation improvements

07 Jan 2020, 18:45

I agree with locking this topic. New posts should are to be separate threads from this one. Post in the new subforum. :+1:
Image Image Image Image Image
Windows 10 x64 Professional, Intel i5-8500, NVIDIA GTX 1060 6GB, 2x8GB G.Skill RipJaws V - DDR4 3280 MHz | [About Me] | [ASPDM - StdLib Distribution]
[Populate the AHK MiniCity!] | [Qonsole - Quake-like console emulator] | [LibCon - Autohotkey Console Library] | [About the AHK Foundation]

Return to “Suggestions on documentation improvements”

Who is online

Users browsing this forum: No registered users and 1 guest