Re: Introducing memcache-ada, a memcached client in Ada

[R Tyler Croy <tyler@linux.com>]

On 2010-12-20, Jeffrey Carter <spam.jrcarter.not@spam.not.acm.org> wrote:
> On 2010-12-20 01:43, R Tyler Croy wrote:
>>
>> I look forward to any comments or suggestions as to the code
>> quality/structure.
>
> I have looked only at the specification, since that's the only part a client 
> should need to look at. Initial impressions:
>
> I see a number of declarations in the visible part of the specification that are 
> not referenced in the visible part nor needed for the client to use the package. 
> Only things needed in the visible part or needed by the client to use the 
> package should appear in the visible part.
>
> [In order of preference, things should be declared
>
> 1. In the body
> 2. In the private part (Is Ada the only language with private parts?)
> 3. In the visible part]
>
> Similarly, context clauses should use "private with" for things only referenced 
> in the private part.
>
> The type Flags and the Set_Flags parameters of that type are not documented in 
> the spec; if possible, they should be. In particular, the effect of the default 
> value for Set_Flags should be described.
>
> The meaning of the expiration parameters, and especially of their default 
> values, should be documented. The default of zero would seem to mean immediate 
> expirations, which doesn't seem very useful.
>
> The meaning of the Boolean return values from some of the functions (which also 
> appear as parameters) is unclear and should be documented.
>
> Some exceptions appear at the end of the visible part. Presumably some of the 
> operations may raise these exceptions, but which operations raise which 
> exceptions, and in what circumstances, is not documented. Since declarations 
> should appear before they are referenced, the exception declarations should 
> appear before the comments in which they are referenced.
>

These are some really good suggestions, thank you for taking the time to look
over the protocol and my code

I look forward to updating some things tonight after work. :)


-- 
- R. Tyler Croy
--------------------------------------
    Code: http://github.com/rtyler
 Chatter: http://twitter.com/agentdero
          http://identi.ca/dero