As you can see in my project [1] the summary is divided in several lines. I think it's because you use `class="col-md-6"` in CSS. Can you change that stylesheet in order to `summary` fits all the horizontal space available?
I think this could improve readability.
Thanks in advance,
[1] https://git.sr.ht/~somenxavierb/apunts-acces-uib-majors-25-anys-matematiques-mirror
On 3/16/23 21:03, Xavier B. wrote:
> As you can see in my project [1] the summary is divided in several> lines. I think it's because you use `class="col-md-6"` in CSS. Can> you change that stylesheet in order to `summary` fits all the> horizontal space available?
I think for small, concrete changes like this you'd get the best
feedback by submitting a patch.
> I think this could improve readability.
True in that case, but I will say: in my opinion, your description is
way too long. I think of the repo description the same way that I think
of the short package description that one can see when searching the
package database of your Linux distribution. It should be much more
concise. For example, Arch guidelines [1] recommend around 80
characters. Debian guidelines [2] don't give a number, but you can infer
from the text that it should be equally brief.
[1] https://wiki.archlinux.org/title/Arch_package_guidelines
[2]
https://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.html#the-package-synopsis-or-short-description
That's just my opinion, of course.
Cheers,
Conrad
Thanks for feedback.
On Fri, 17 Mar 2023 10:09:11 +0100
Conrad Hoffmann <ch@bitfehler.net> ha escrit:
> On 3/16/23 21:03, Xavier B. wrote:> > As you can see in my project [1] the summary is divided in several> > lines. I think it's because you use `class="col-md-6"` in CSS. Can> > you change that stylesheet in order to `summary` fits all the> > horizontal space available?> > I think for small, concrete changes like this you'd get the best > feedback by submitting a patch.
I don't know how to submit a patch. I'm just a simple user.
On the other hand, I think that the change is so minimum that it could be done very straighforward.
> > > I think this could improve readability.> > True in that case, but I will say: in my opinion, your description is > way too long. I think of the repo description the same way that I think > of the short package description that one can see when searching the > package database of your Linux distribution. It should be much more > concise. For example, Arch guidelines [1] recommend around 80 > characters. Debian guidelines [2] don't give a number, but you can infer > from the text that it should be equally brief.> > [1] https://wiki.archlinux.org/title/Arch_package_guidelines> [2] > https://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.html#the-package-synopsis-or-short-description>
The format is subjective. I think sourcehut and other git web interfaces need to have neutral CSS in order to work whatever format of project info is.
Thanks,
Hi,
On Wed, 2023-03-22 at 21:22 +0000, Xavier B. wrote:
> > I don't know how to submit a patch. I'm just a simple user.> On the other hand, I think that the change is so minimum that it> could be done very straighforward.
It's always fun to learn! Drew has a good tutorial at
https://git-send-email.io> The format is subjective. I think sourcehut and other git web> interfaces need to have neutral CSS in order to work whatever format> of project info is.
Sourcehut is rather opinionated already, I don't think this will be
enough to change that. I agree that repo descriptions should be
relatively short and to the point. Most of the information could be put
in the README, you can present it much better there.
Best,
Cara (she/her)
> As you can see in my project [1] the summary is divided in> several lines. I think it's because you use `class="col-md-6"` in CSS.
The text wraps because the area is divided into two sections:
<div class="row">
<div class="col-md-6">
Go package for controlling a Starlink Dishy device
</div>
<div class="col-md-6 licenses"></div>
</div>
Maybe that space is reserved for a future feature where a short
description of the project’s license is shown?
Cool, Oliver. It has sense. Perhaps Drew or sr.ht could explain if it's
true.
Thanks,
A 22.03.2023 22:53, Oliver Lowe escrigué:
>> As you can see in my project [1] the summary is divided in>> several lines. I think it's because you use `class="col-md-6"` in CSS.> > The text wraps because the area is divided into two sections:> > <div class="row">> <div class="col-md-6">> Go package for controlling a Starlink Dishy device> </div>> <div class="col-md-6 licenses"></div>> </div>> > Maybe that space is reserved for a future feature where a short> description of the project’s license is shown?
On Thu Mar 23, 2023 at 12:27 PM CET, Xavier wrote:
> A 22.03.2023 22:53, Oliver Lowe escrigué:> > The text wraps because the area is divided into two sections:> > <div class="row">> > <div class="col-md-6">> > Go package for controlling a Starlink Dishy device> > </div>> > <div class="col-md-6 licenses"></div>> > </div>> > Maybe that space is reserved for a future feature where a short> > description of the project’s license is shown?> Perhaps Drew or sr.ht could explain if it's true.
This is because Sourcehut repositories support showing used licenses if the
repository adheres to the REUSE spec[1], which was introduced by ~vladh in
a00fc083e409caab36f480d0ba0a459b4abca00e[2].
An example of this can be seen here:
https://git.sr.ht/~witcher/todotxt_parser
My 2 cents are that if your description wraps it's too long and you should
shorten it, ideally expanding on the description in the README.
Cheers.
[1]: https://reuse.software/spec/
[2]: https://git.sr.ht/~sircmpwn/git.sr.ht/commit/a00fc083e409caab36f480d0ba0a459b4abca00e#gitsrht/templates/summary.html-1-5
--
witcher