User talk:Red Leader: Difference between revisions

Jump to navigation Jump to search
m (→‎updating articles to use repo link templates: not necessarily exact, but still ...)
Line 127: Line 127:


== Nasal positioned APIs (navcache) ==
== Nasal positioned APIs (navcache) ==
Referring to the commit/change at [http://wiki.flightgear.org/index.php?title=Nasal_library&oldid=89398]. I appreciate what you are doing there, but I would really suggest not to spread our Nasal API docs across multiple articles. The NavCache article documents an underlying implementation detail of the NavDB, i.e. it being cached using a very fragile SQLite layer, so it is mainly about the "cache", but not the functionality provided on top of it, i.e. the NavDB itself. And in fact, at some point, we were not even using/having such a caching layer, and we may not even have the cache in its current form in the future given how this has crippled the FG experienced for literally hundreds of FG users. So I would suggest not to split up our docs by adding useful info to related articles. For instance, at some point we had another attempt at "caching" using the metakit dependency - which is meanwhile gone. Which is to say that the cache is an implementation detail, that may be subject to change sooner or later (hopefully just subject to fixing), but the public/external APIs are unlikely to change in any major way, because end-users rely on those. And one of the most significant feats you have pulled off with your Nasal docs article is consolidating all the info in a single place, which makes it much easier to update things in the future, especially should things change at some point, especially because of all the templates you are using. So I really vote for having a single monolithic article for the time being, i.e. it may be better to either refer to the reference section you created, or include it using a template instead - to ensure that we don't violate the DRY-principle but still have everything neatly encapsulated (imagine fixing up the API template to link back to tons of unrelated articles).--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:49, 10 November 2015 (EST)


Referring to the commit/change at [http://wiki.flightgear.org/index.php?title=Nasal_library&oldid=89398]. I appreciate what you are doing there, but I would really suggest not to spread our Nasal API docs across multiple articles. The NavCache article documents an underlying implementation detail of the NavDB, i.e. it being cached using a very fragile SQLite layer, so it is mainly about the "cache", but not the functionality provided on top of it, i.e. the NavDB itself. And in fact, at some point, we were not even using/having such a caching layer, and we may not even have the cache in its current form in the future given how this has crippled the FG experienced for literally hundreds of FG users. So I would suggest not to split up our docs by adding useful info to related articles. For instance, at some point we had another attempt at "caching" using the metakit dependency - which is meanwhile gone. Which is to say that the cache is an implementation detail, that may be subject to change sooner or later (hopefully just subject to fixing), but the public/external APIs are unlikely to change in any major way, because end-users rely on those. And one of the most significant feats you have pulled off with your Nasal docs article is consolidating all the info in a single place, which makes it much easier to update things in the future, especially should things change at some point, especially because of all the templates you are using. So I really vote for having a single monolithic article for the time being, i.e. it may be better to either refer to the reference section you created, or include it using a template instead - to ensure that we don't violate the DRY-principle but still have everything neatly encapsulated (imagine fixing up the API template to link back to tons of unrelated articles).--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 10:49, 10 November 2015 (EST)
: Hi Hooray,
: I understand that it may not be the best solution for now, but they won't do any harm being there for now. They can be removed when they have been documented at [[Nasal library]]. In my research into {{func link|airportinfo()}} and {{func link|airwaysRoute()}}, it became apparent to me that both the functions which are based around FGPositioned and those that use <code>waypoint</code>, <code>airport</code>, ''et al'' ghost objects need documenting. Also, I plan that [[Nasal library]] will contain just the global functions, with subpages containing various namespace documentation (e.g., [[Nasal library/math]]).
 
: Regards,
: [[User:Red_Leader|<span style="color:red">'''''Red Leader'''''</span>]] ([[User_talk:Red_Leader|Talk]], [[Special:Contributions/Red_Leader|contribs]]) 15:55, 15 November 2015 (EST)


== Instant cquotes and youtube videos ==
== Instant cquotes and youtube videos ==

Navigation menu