Default Documentations

I’ve been using Iced for a while now and noticed that while the documentation for most of the library there are still some minor issues; mainly default documentations.

What do I mean by that? A lot of types implement the default trait, but don’t mention how they do so. Row has a default implementation but does not tell you what the values (height, width, clip, padding, etc) for a default Row is. The only way to know is to either dig through the source code or experiment.

Is there a reason behind this? The only reason I could think of is given how much of a work in progress Iced is, those specifics might be volatile.

But yeah. Just curious

The documentation for this library is overall very poor. The examples given in the README don’t even work.

Why do users keep assuming that the master branch of a repository documents the latest release? I am baffled every time. Have they no idea of how software development works?

Do brains still serve a purpose nowadays? Or do people just have them as counterweight?

Is it really necessary for a highly experimental software library to spoonfeed you the default values of a widget?

Generally, a Default implementation does not need to be documented because it should be obvious.

Also, remember that you can click in the source link in the API reference to see the implementation of a trait right there:

There are many parts of the documentation that need work; but this ain’t it, chief.

2 Likes