Volunteer github guru for documentation submissions?

[Devin Asay]

> On Apr 11, 2016, at 9:23 PM, Kay C Lan <lan.kc.macmail at gmail.com> wrote:
> 
>> 
>> On Apr 11, 2016, at 8:31 PM, J. Landman Gay <jacque at hyperactivesw.com>
>> wrote:
>>> 
>>> I think it says "object" should only be used for glossary entries:
>> 
>> On Tue, Apr 12, 2016 at 11:01 AM, Devin Asay <devin_asay at byu.edu> wrote:
>> 
>> Well, okay, but this confuses me.
>> 
>> Devin
>> 
>> In LC8 dp16 Dictionary, type in 'do state' and click on the 'do statement'
> entry. Scroll down and have a look at 'Related:' the various Linked entries
> - keyword; command: function: glossary:
> 
> Note that it just happens that none of the Glossary entries have anything
> to do with objects.
> 
> Then in the Description section, if you pass you mouse along the first line
> of the 2nd paragraph you'll note that the words 'command', 'executing',
> 'commands' turn into links.
> 
> Hopefully that better explains what I tried to type in my previous post.

Yes, Kay, thanks. I actually think I understand pretty well about needing to list everything in the Related: section for which you have links in the Description section. And you need to be careful about getting the correct entry in the Related section. For instance, when I was overhauling the HTMLText property document, I noticed that the Related section listed both ‘field (object)’ and 'field (keyword)’. Some of the links within the Description section referenced field(object) and some referenced field(keyword). But if you go and look up field keyword in the dictionary, its use as a KEYWORD is very narrow—and is limited to things like ‘choose field tool’. That obviously doesn’t apply to anything in the HTMLText entry, which refers to fields a lot, but only to fields as OBJECTS. So I made the decision to remove field (keyword) altogether from that document. I think that was the right decision. I’ll see what Ali says when he reviews it.

I’m actually kinda having fun, and I saw my name in the list of open source contributors in Peter Brett’s weekly open source newsletter! :)

Devin


Devin Asay
Learn to code with LiveCode University
https://livecode.com/store/education/