[Gambas-user] [RFC] Where to place documentation for a library or component?

[Benoît Minisini]

Le 02/07/2019 à 06:38, Yeshua Rodas a écrit :
> Hello coders.
> 
> You'll see, I am developing a query builder for Gambas based on a PHP 
> query builder from Nil Portugues 
> (https://github.com/nilportugues/php-sql-query-builder).
> 
> At the moment I have almost completed a basic API for `INSERT` and 
> `SELECT` very similar to the original one, with some variations of 
> course. Something like this:
> 
>    Dim builder As SelectBuilder = New SelectBuilder(hConn)
>    Dim result As String
> 
>    builder.select("fake", ["foo", "bar", "baz"]).where().equals("bar", 
> "baz")
>    builder.subWhere("OR").notLike("foo", "something").greaterThan("baz", 6)
> 
>    result = builder.getSql()
>    ' Output: "SELECT fake.foo, fake.bar, fake.baz FROM fake WHERE 
> (fake.bar = 'baz') AND ((fake.foo NOT LIKE 'something') OR (fake.baz > 6))"

There is a similar class in 'gb.db' named SqlRequest, with apparently 
less features. Maybe you should have enhanced it instead!

> 
> So, I want to share this early stage for (maybe) get some feedback.
> Well, now on topic, I'm writing documentation for this stage, but I'm 
> unsure about the best place for it. Usually I create a separated 
> repository and work with ReadTheDocs and reStructuredText, however, 
> gambaswiki.org <http://gambaswiki.org> seems to me a good place to share 
> the project.

I don't know what you mean exactly... The Gambas wiki is for writing 
documentation about Gambas components, not about private components.

Regards,

-- 
Benoît Minisini