FreshPorts / freshports

The website part of FreshPorts
http://www.freshports.org/
BSD 2-Clause "Simplified" License
68 stars 24 forks source link

Commit found by commit id: comprehension, and possible nits #400

Open grahamperrin opened 1 year ago

grahamperrin commented 1 year ago

https://www.freshports.org/commit.php?category=databases&port=mysql55-client&files=yes&message_id=305f148f482daf30dcf728039d03d019f88344eb, for example:

Initially, I misunderstood this part of the page, below the long list:

image

– misunderstood because I had skipped through the page too fast and, of course, what's above that part of the page is not just "stuff" – each line is a commit. My bad, poor (lazy) comprehension.


Then, this part of the page:

image

Number of ports [& non-ports] in this commit: 29222

Hmm, did I truly skip through a list of nearly thirty thousand ports and non-ports?

No, and :-) I'm glad that FreshPorts did not present that many. From source of the page, I guess that there's a reasonable limit to the number of listings:

For edge cases such as this, the page might be improved to state the limit, and maybe explain how the subset (to be listed) was chosen.


Finally, after clicking show all files, I see a string of three threes not far from a string of three twos:

image

The triplets are eye-catching. The two counts might be true (I'm too lazy to check, at the moment) … but in the context of a page where something is limited, I get suspicious about things that catch my eye.

grahamperrin commented 1 year ago

Afterthought: presentation of the number of ports and non-ports

image

I might have been partly confused by the border that entirely surrounds the statement.

Whilst removing the top border might be conceptually better (not separating the statement from the area to which it relates), it might also cause the statement to be overlooked.

Maybe move the statement, to be above the list of ports and non-ports?

(Do I understand correctly?)

grahamperrin commented 1 year ago

Afterthought: the files section

image

Radio button representation might help to make what's bordered (above) more immediately recognisable as three distinct views. Something like this:

[ Hide files ] [[ Files for databases/mysql55-client alone ]] [ Show all files]

dlangille commented 1 year ago

Initially, I misunderstood this part of the page, below the long list:

image

– misunderstood because I had skipped through the page too fast and, of course, what's above that part of the page is not just "stuff" – each line is a commit. My bad, poor (lazy) comprehension.

The commit message should be collapsed (i.e. a summary) like it is on the data.php page (https://www.freshports.org/date.php?date=2021/4/6)

Screen Shot 2022-10-13 at 10 09 37 AM

Also: perhaps the commit message should appear first, followed by the list of ports. This might be applied to all pages.

dlangille commented 1 year ago

Then, this part of the page:

image

Number of ports [& non-ports] in this commit: 29222

Hmm, did I truly skip through a list of nearly thirty thousand ports and non-ports?

No, and :-) I'm glad that FreshPorts did not present that many. From source of the page, I guess that there's a reasonable limit to the number of listings:

  • 500

I think that's from here:

www/backend/commits.php: DEFINE('MAXROWS', 15000); www/commit.php: DEFINE('DEFAULT_PAGE_SIZE', 500);

For edge cases such as this, the page might be improved to state the limit, and maybe explain how the subset (to be listed) was chosen.

The page should list all the commits, however ugly that is. The collapsed state mentioned in a previous comment would apply.

Finally, after clicking show all files, I see a string of three threes not far from a string of three twos:

image

The triplets are eye-catching. The two counts might be true (I'm too lazy to check, at the moment) … but in the context of a page where something is limited, I get suspicious about things that catch my eye.

Any action required here? Just eye-catching?

dlangille commented 1 year ago

Afterthought: presentation of the number of ports and non-ports

image

I might have been partly confused by the border that entirely surrounds the statement.

Whilst removing the top border might be conceptually better (not separating the statement from the area to which it relates), it might also cause the statement to be overlooked.

Maybe move the statement, to be above the list of ports and non-ports?

(Do I understand correctly?)

Moving it to the top might be best.

dlangille commented 1 year ago

Afterthought: the files section

image

Radio button representation might help to make what's bordered (above) more immediately recognisable as three distinct views. Something like this:

[ Hide files ] [[ Files for databases/mysql55-client alone ]] [ Show all files]

That sounds better.

They are three separate pages are present. The URLs are different. Radio buttons don't seem right for launching a new page. The page could be changed though, to be just one.

dlangille commented 1 year ago

– misunderstood because I had skipped through the page too fast and, of course, what's above that part of the page is not just "stuff" – each line is a commit. My bad, poor (lazy) comprehension.

Each line is a port touched by this commit.

dlangille commented 1 year ago

There's more than one change suggestion here. This is the summary: