[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-panel-devel
Subject: Re: Review Request: Activity ResourceInstance class for API review
From: "Aaron J. Seigo" <aseigo () kde ! org>
Date: 2011-05-04 10:00:48
Message-ID: 20110504100048.13312.95246 () vidsolbach ! de
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
> On May 2, 2011, 3:14 p.m., Ivan Čukić wrote:
> > experimental/libkactivities/resourceinstance.h, line 52
> > <http://git.reviewboard.kde.org/r/101273/diff/2/?file=15928#file15928line52>
> >
> > The thing I don't like about the /empty/ constructor is that the user could thing \
> > the class will work if only some props or none are defined.
>
> Sebastian Trueg wrote:
> I agree here. IMHO the default constructor should either take all the required \
> parameters or we need some kind of error handling.
i don't think developers will be confused, and we see this pattern throughout Qt. the \
exception to an "empty" constructor is when the parameters are unchangeable once the \
object is created. many classes provide convenience constructors in addition where it \
makes sense; it could be useful here to also have a constructor that accepts a QUrl \
as well as QObject * parent and nothing else in addition to the "empty" consturctor.
in any case, the URL (and other parts) are not static within the object; they can be \
changed (even set to null, one would expect) and as such the "empty" constructor \
creates an object in the base state and encourages code that is more readable to be \
written. having a complex constructor does little (or nothing) to clear up which \
properties are required and which are optional. something to consider: it is possible \
to return KUrl() from the object, so trying to imply otherwise via the constructor is \
not particularly accurate. :)
this is one of the issues that was part of Ettrich's "creating good APIs" \
presentation at the first Akademy :)
- Aaron J.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://git.reviewboard.kde.org/r/101273/#review3062
-----------------------------------------------------------
On May 2, 2011, 3:11 p.m., Ivan Čukić wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/101273/
> -----------------------------------------------------------
>
> (Updated May 2, 2011, 3:11 p.m.)
>
>
> Review request for Nepomuk and Plasma.
>
>
> Summary
> -------
>
> Desc of the class is in the class apidocs
>
>
> Diffs
> -----
>
> experimental/libkactivities/resourceinstance.h PRE-CREATION
>
> Diff: http://git.reviewboard.kde.org/r/101273/diff
>
>
> Testing
> -------
>
>
> Thanks,
>
> Ivan
>
>
[Attachment #5 (text/html)]
<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="8" style="border: 1px #c9c399 \
solid;"> <tr>
<td>
This is an automatically generated e-mail. To reply, visit:
<a href="http://git.reviewboard.kde.org/r/101273/">http://git.reviewboard.kde.org/r/101273/</a>
</td>
</tr>
</table>
<br />
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <p style="margin-top: 0;">On May 2nd, 2011, 3:14 p.m., <b>Ivan Čukić</b> \
wrote:</p> <blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; \
padding-left: 10px;">
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; \
border-collapse: collapse; margin: 2px padding: 2px;"> <thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; \
font-size: 9pt; padding: 4px 8px; text-align: left;"> <a \
href="http://git.reviewboard.kde.org/r/101273/diff/2/?file=15928#file15928line52" \
style="color: black; font-weight: bold; text-decoration: \
underline;">experimental/libkactivities/resourceinstance.h</a> <span \
style="font-weight: normal;">
(Diff revision 2)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; \
"></pre></td> <td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: \
0; ">public:</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" \
align="right"><font size="2"></font></th> <td bgcolor="#c5ffc4" width="50%"><pre \
style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td> <th \
bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid \
#C0C0C0;" align="right"><font size="2">52</font></th> <td bgcolor="#c5ffc4" \
width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span \
class="n">ResourceInstance</span><span class="p">(</span><span \
class="n">QObject</span> <span class="o">*</span> <span class="n">parent</span> <span \
class="o">=</span> <span class="mi">0</span><span class="p">);</span></pre></td> \
</tr>
</tbody>
</table>
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">The thing I don't \
like about the /empty/ constructor is that the user could thing the class will work \
if only some props or none are defined.</pre> </blockquote>
<p>On May 2nd, 2011, 3:41 p.m., <b>Sebastian Trueg</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">I agree here. IMHO the \
default constructor should either take all the required parameters or we need some \
kind of error handling.</pre> </blockquote>
</blockquote>
<pre style="margin-left: 1em; white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">i don't \
think developers will be confused, and we see this pattern throughout Qt. the \
exception to an "empty" constructor is when the parameters are unchangeable \
once the object is created. many classes provide convenience constructors in addition \
where it makes sense; it could be useful here to also have a constructor that accepts \
a QUrl as well as QObject * parent and nothing else in addition to the \
"empty" consturctor.
in any case, the URL (and other parts) are not static within the object; they can be \
changed (even set to null, one would expect) and as such the "empty" \
constructor creates an object in the base state and encourages code that is more \
readable to be written. having a complex constructor does little (or nothing) to \
clear up which properties are required and which are optional. something to consider: \
it is possible to return KUrl() from the object, so trying to imply otherwise via the \
constructor is not particularly accurate. :)
this is one of the issues that was part of Ettrich's "creating good \
APIs" presentation at the first Akademy :)</pre> <br />
<p>- Aaron J.</p>
<br />
<p>On May 2nd, 2011, 3:11 p.m., Ivan Čukić wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" \
style="background-image: \
url('http://git.reviewboard.kde.org/media/rb/images/review_request_box_top_bg.png'); \
background-position: left top; background-repeat: repeat-x; border: 1px black \
solid;"> <tr>
<td>
<div>Review request for Nepomuk and Plasma.</div>
<div>By Ivan Čukić.</div>
<p style="color: grey;"><i>Updated May 2, 2011, 3:11 p.m.</i></p>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">Desc of the class is in the class apidocs</pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>experimental/libkactivities/resourceinstance.h <span style="color: \
grey">(PRE-CREATION)</span></li>
</ul>
<p><a href="http://git.reviewboard.kde.org/r/101273/diff/" style="margin-left: \
3em;">View Diff</a></p>
</td>
</tr>
</table>
</div>
</body>
</html>
_______________________________________________
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic