UTDNebula / utd-trends

Make good choices, choose the perfect classes for you
https://trends.utdnebula.com
MIT License
19 stars 12 forks source link

[Feature Request]: Show extra information from course description #174

Open AbhiramTadepalli opened 2 months ago

AbhiramTadepalli commented 2 months ago

Overview

The course description contains key information that is technically different from the description of the course. The goal is to separate these from the description paragraph because (a) it is technically possible and (b) highlights important details about the class.

Proposal

Certain course descriptions have information at the end, like prerequisites, notices, lab fees, etc. For readability (and to highlight these), parse the course description and separate the additional information onto a different line.

Supplementary Information

The requisites are already separated (https://github.com/UTDNebula/utd-trends/pull/166/commits/54603a947e1c401ddbdbbeb81be626a4233ecded)

The description always ends with something like "(3-0) S"

Tasks

TyHil commented 2 months ago

@AbhiramTadepalli has API already done this or is this different? See the course return format which includes requisites: https://github.com/UTDNebula/nebula-api/blob/develop/docs/schemas/course.md I think these are lists of course IDs so we'd have to make another API call to get their names but that might be better than parsing it from the description

AbhiramTadepalli commented 2 months ago

I think these are lists of course IDs

Yep, that's why I was parsing manually, but

we'd have to make another API call to get their names but that might be better than parsing it from the description

this sounds good.

However, we would still have to identify it and remove it from the course description.

The API doesn't have lab fees or anything like that which some course descriptions have at the end, which must then be done manually.

TyHil commented 2 months ago

Gosh this gets messy. So this feature request is to switch to pulling requisites from the API while still removing them from the description?

I do think removing things like lab fees (and even just removing requisites maybe) from the description and separating them might just always end up not working on some course because of how non-uniform the course descriptions are. Maybe it could all be left in and truncated with like a "Show more" button if too long

AbhiramTadepalli commented 2 months ago

Related to #173

egsch commented 1 month ago

Types of additional information:

Starred ones seem doable and potentially important to pull out of the description to highlight.

egsch commented 1 month ago

Made a version pulling out lab fees, consent required, credit/no credit on branch. Not sure if it's an improvement over the past version, so I'm going to leave this here and focus on other issues until the redesign release. If anyone has input on this please leave a comment!

AbhiramTadepalli commented 1 month ago

Sounds good!