Spec Documentation case 18653

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Spec Documentation case 18653

Marion Noirbent
Hi,
I have begin a documentation for Spec-core-widget (and some classes
close of it). I have let some todo when I didn't sure to understand or
when I didn't found how make it work.

I have refactor some minor things too.

Details are in the zip, "Spec_changes_details.txt".

Spec_doc.zip (11K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Spec Documentation case 18653

stepharo
Thanks marion

Do not send zipped files because people will not save and unzip attachments.

So I'm trying to understand what you mean?

Did you create some issues on fogzbug?

What has been published in 18653?

What do you want from us?

What is the next step?



Some of examples refered in the documentation can be found in the
package Spec-BuildUIWithSpec. It contains examples in the book "Building
UI with Spec" but it is not finished, so it could change a lot
(structure, adding content, refactoring others examples, ...) but
refered examples should be stable.


REFACTOR
========

* Package
I have moved what wasn't really widgets from Spec-core-widget to
Spec-core-widget-support or Spec-core-support.

* AbstractFormButtonModel
I have create the abstract class AbstractFormButtonModel to remove code
duplication beetween CheckboxModel and RadioButtonModel.

* TextInputFieldModel
I have removed the instance variable alwaysAccept that didn't have
accessors and was not initialized.


DOCUMENTATION
=============

Spec-core
---------

* ComposableModel
The documentation is split in three part. There is two todo.

I haven't found how work hide and windowIcon: , I don't know build a
window accepting cancelled to test it.


* AbstractWidgetModel
One todo (3 elements)
I haven't found how work defaultColor and color.

borderWidth and borderColor have strange behaviour, it seems depend of
its subclass (even if it not define again). ButtonModel don't make it
appear but it work with the checkbox.

Reproduce :

| button checkBox |
button := ButtonModel new.
button
     openWithSpec;
     label: 'Click me';
     borderWidth: 5;
     borderColor: Color red.

checkBox := CheckBoxModel new.
checkBox
     label: 'Click me';
     openWithSpec;
     borderWidth: 5;
     borderColor: Color red.

Result : borderWidthborderColor.png
I have try to put it in a ComposableModel too.


* DynamicComposableModel
One todo (2 elements)


Spec-Core-Support
-------------------------

* SpecFocusOrder
No todo, need review.


Spec-Core-Widgets-Support
-------------------------

* AbstractFormButtonModel
No todo, need review.

* RadioButtonGroup
One todo (1 element)


Spec-core-widget
----------------

* ButtonModel
One todo

* CheckboxModel
One todo (3 elements)
I haven't found how work labelOnLeft and labelOnRight, and labelClickable.

* ImageModel
No todo, need review.

* LabelModel
One todo (1 element)

* ListModel
One todo

* IconListModel
One todo (1 element)

* MenuGroupModel
One todo

* MenuItemModel
One todo

* MenuModel
One todo

* RadioButtonGroupModel
One todo (1 element)
I have previously create this class from RadioButtonGroup (renaming it)
so there is code duplication between them.

* RadioButtonModel
No todo, need review.

* SliderModel
One todo (1 element)

* TextModel
The biggest todo
I have try to comment some parts in ScrollSyncExample to try scrollValue
but the scroll keep working.

* TextInputFieldModel
One todo



Reply | Threaded
Open this post in threaded view
|

Re: Spec Documentation case 18653

Marion Noirbent
I have create the case 18653 Spec documentation to integrate the
comments of classes.
I have create a slice with the comments I have wroten and save it in the
inbox.
But the slice is not complete because there are lot of things I didn't
understand about Spec.
I haven't resolve the case.

Now I would like :
- someone review what I have done
- someone complete what I couldn't do
- someone resolve the case when it will be ready

The text behind indicates the work needed on all classes I have modified.

For my part, I will try to resolves some critics and create some tests.



Le 01/07/2016 09:14, stepharo a écrit :

> Thanks marion
>
> Do not send zipped files because people will not save and unzip
> attachments.
>
> So I'm trying to understand what you mean?
>
> Did you create some issues on fogzbug?
>
> What has been published in 18653?
>
> What do you want from us?
>
> What is the next step?
>
>
>
> Some of examples refered in the documentation can be found in the
> package Spec-BuildUIWithSpec. It contains examples in the book "Building
> UI with Spec" but it is not finished, so it could change a lot
> (structure, adding content, refactoring others examples, ...) but
> refered examples should be stable.
>
>
> REFACTOR
> ========
>
> * Package
> I have moved what wasn't really widgets from Spec-core-widget to
> Spec-core-widget-support or Spec-core-support.
>
> * AbstractFormButtonModel
> I have create the abstract class AbstractFormButtonModel to remove code
> duplication beetween CheckboxModel and RadioButtonModel.
>
> * TextInputFieldModel
> I have removed the instance variable alwaysAccept that didn't have
> accessors and was not initialized.
>
>
> DOCUMENTATION
> =============
>
> Spec-core
> ---------
>
> * ComposableModel
> The documentation is split in three part. There is two todo.
>
> I haven't found how work hide and windowIcon: , I don't know build a
> window accepting cancelled to test it.
>
>
> * AbstractWidgetModel
> One todo (3 elements)
> I haven't found how work defaultColor and color.
>
> borderWidth and borderColor have strange behaviour, it seems depend of
> its subclass (even if it not define again). ButtonModel don't make it
> appear but it work with the checkbox.
>
> Reproduce :
>
> | button checkBox |
> button := ButtonModel new.
> button
>     openWithSpec;
>     label: 'Click me';
>     borderWidth: 5;
>     borderColor: Color red.
>
> checkBox := CheckBoxModel new.
> checkBox
>     label: 'Click me';
>     openWithSpec;
>     borderWidth: 5;
>     borderColor: Color red.
>
> Result : borderWidthborderColor.png
> I have try to put it in a ComposableModel too.
>
>
> * DynamicComposableModel
> One todo (2 elements)
>
>
> Spec-Core-Support
> -------------------------
>
> * SpecFocusOrder
> No todo, need review.
>
>
> Spec-Core-Widgets-Support
> -------------------------
>
> * AbstractFormButtonModel
> No todo, need review.
>
> * RadioButtonGroup
> One todo (1 element)
>
>
> Spec-core-widget
> ----------------
>
> * ButtonModel
> One todo
>
> * CheckboxModel
> One todo (3 elements)
> I haven't found how work labelOnLeft and labelOnRight, and labelClickable.
>
> * ImageModel
> No todo, need review.
>
> * LabelModel
> One todo (1 element)
>
> * ListModel
> One todo
>
> * IconListModel
> One todo (1 element)
>
> * MenuGroupModel
> One todo
>
> * MenuItemModel
> One todo
>
> * MenuModel
> One todo
>
> * RadioButtonGroupModel
> One todo (1 element)
> I have previously create this class from RadioButtonGroup (renaming it)
> so there is code duplication between them.
>
> * RadioButtonModel
> No todo, need review.
>
> * SliderModel
> One todo (1 element)
>
> * TextModel
> The biggest todo
> I have try to comment some parts in ScrollSyncExample to try scrollValue
> but the scroll keep working.
>
> * TextInputFieldModel
> One todo
>
>
>

Reply | Threaded
Open this post in threaded view
|

Re: Spec Documentation case 18653

jfabry

I will take care of this next week when I am in Lille.

--
Does this mail seem too brief? Sorry for that, I don’t mean to be rude! Please see http://emailcharter.org .

Johan Fabry   -   http://pleiad.cl/~jfabry
PLEIAD and RyCh labs  -  Computer Science Department (DCC)  -  University of Chile

> On Jul 1, 2016, at 04:37, Marion Noirbent <[hidden email]> wrote:
>
> I have create the case 18653 Spec documentation to integrate the
> comments of classes.
> I have create a slice with the comments I have wroten and save it in the
> inbox.
> But the slice is not complete because there are lot of things I didn't
> understand about Spec.
> I haven't resolve the case.
>
> Now I would like :
> - someone review what I have done
> - someone complete what I couldn't do
> - someone resolve the case when it will be ready
>
> The text behind indicates the work needed on all classes I have modified.
>
> For my part, I will try to resolves some critics and create some tests.
>
>
>
> Le 01/07/2016 09:14, stepharo a écrit :
>> Thanks marion
>>
>> Do not send zipped files because people will not save and unzip
>> attachments.
>>
>> So I'm trying to understand what you mean?
>>
>> Did you create some issues on fogzbug?
>>
>> What has been published in 18653?
>>
>> What do you want from us?
>>
>> What is the next step?
>>
>>
>>
>> Some of examples refered in the documentation can be found in the
>> package Spec-BuildUIWithSpec. It contains examples in the book "Building
>> UI with Spec" but it is not finished, so it could change a lot
>> (structure, adding content, refactoring others examples, ...) but
>> refered examples should be stable.
>>
>>
>> REFACTOR
>> ========
>>
>> * Package
>> I have moved what wasn't really widgets from Spec-core-widget to
>> Spec-core-widget-support or Spec-core-support.
>>
>> * AbstractFormButtonModel
>> I have create the abstract class AbstractFormButtonModel to remove code
>> duplication beetween CheckboxModel and RadioButtonModel.
>>
>> * TextInputFieldModel
>> I have removed the instance variable alwaysAccept that didn't have
>> accessors and was not initialized.
>>
>>
>> DOCUMENTATION
>> =============
>>
>> Spec-core
>> ---------
>>
>> * ComposableModel
>> The documentation is split in three part. There is two todo.
>>
>> I haven't found how work hide and windowIcon: , I don't know build a
>> window accepting cancelled to test it.
>>
>>
>> * AbstractWidgetModel
>> One todo (3 elements)
>> I haven't found how work defaultColor and color.
>>
>> borderWidth and borderColor have strange behaviour, it seems depend of
>> its subclass (even if it not define again). ButtonModel don't make it
>> appear but it work with the checkbox.
>>
>> Reproduce :
>>
>> | button checkBox |
>> button := ButtonModel new.
>> button
>>    openWithSpec;
>>    label: 'Click me';
>>    borderWidth: 5;
>>    borderColor: Color red.
>>
>> checkBox := CheckBoxModel new.
>> checkBox
>>    label: 'Click me';
>>    openWithSpec;
>>    borderWidth: 5;
>>    borderColor: Color red.
>>
>> Result : borderWidthborderColor.png
>> I have try to put it in a ComposableModel too.
>>
>>
>> * DynamicComposableModel
>> One todo (2 elements)
>>
>>
>> Spec-Core-Support
>> -------------------------
>>
>> * SpecFocusOrder
>> No todo, need review.
>>
>>
>> Spec-Core-Widgets-Support
>> -------------------------
>>
>> * AbstractFormButtonModel
>> No todo, need review.
>>
>> * RadioButtonGroup
>> One todo (1 element)
>>
>>
>> Spec-core-widget
>> ----------------
>>
>> * ButtonModel
>> One todo
>>
>> * CheckboxModel
>> One todo (3 elements)
>> I haven't found how work labelOnLeft and labelOnRight, and labelClickable.
>>
>> * ImageModel
>> No todo, need review.
>>
>> * LabelModel
>> One todo (1 element)
>>
>> * ListModel
>> One todo
>>
>> * IconListModel
>> One todo (1 element)
>>
>> * MenuGroupModel
>> One todo
>>
>> * MenuItemModel
>> One todo
>>
>> * MenuModel
>> One todo
>>
>> * RadioButtonGroupModel
>> One todo (1 element)
>> I have previously create this class from RadioButtonGroup (renaming it)
>> so there is code duplication between them.
>>
>> * RadioButtonModel
>> No todo, need review.
>>
>> * SliderModel
>> One todo (1 element)
>>
>> * TextModel
>> The biggest todo
>> I have try to comment some parts in ScrollSyncExample to try scrollValue
>> but the scroll keep working.
>>
>> * TextInputFieldModel
>> One todo
>>
>>
>>
>
>