jonas-chow / pe Goto Github PK

Zoom links can be any string of characters. This should not be the case.

There should be verification to ensure that the link provided is indeed a valid link.

Nothing really states that clist and elist will always show the linked events/contacts even when some prefixes are provided.

Actual telegram handles are only allowed to go up to 30 characters long.

A check should be in place to make sure that users do not input invalid telegram handles.

While rare, it is possible to have two friends with the exact same name.

Steps to reproduce:
Add a person, and then add another person with the same name.

The tables are located around pages 10-13

Some icons are repeated e.g. links/websites, tags, bookmarks

It would be better if the two tables were combined together, since there doesn't seem to be that big of a difference between the two.

It is quite common for names to contain symbols. For example, "s/o" is quite commonly used in names. Hyphens are also occasionally in some longer names.

The tag is not added, but the command doesn't get stopped and no warning is given to the user.

To reproduce: run cedit <index> <some field> t/*

In the tables from page 10-13, the icons take up far more vertical space than they should.

This results in the section being overly long, especially since some of the icons are repeated.

The icons should be a similar height as the one line of text on the right column.

Error message should reflect that tag can only be alphanumeric. It seems like this is only an issue for the t/ prefix.

Multiple method calls on a single arrow looks very squeezy.

goodbye world

Events have the address icon, but this is not listed in the table on pages 12-13 of the UG.

From the UG:
When editing tags, the tags to be deleted will be removed first, before new tags are added.

Logically, the hello tag would be deleted first before the adding it back, and so contact wouldn't "already have the [hello] tag"

In fact, if cedit dt/* t/hello was run here, the note would not appear.

To reproduce: give someone a "hello" tag and run cedit <index> dt/hello t/hello

If I were a new user following the guide one command at a time using the sample data, I would be clearing all contacts before having a chance to try out deleting, editing, etc.

I would then have to add a bunch of contacts on my own in order to try out the later commands. This is very inconvenient.

The cclear command should be at the bottom of the contacts management list.

Same thing goes for events.

There could be a case where I made a typo for the index, and it became out of bounds. Would need to retype the index then.

The UG even says:
You must check that the contact indexed at INDEX is initially marked.

so it seems reasonable to throw an exception if the contact at index is not marked

In DG page 13 and 16

ran: cmark 2

Remarked a user at the bottom of the marked list, and the user was moved back to the top of the mark list.

Command result gives the impression that my command had no effect.

Most activity diagrams use [else] to specify the alternate path. This one does not.

It is not easy to see the separation between the delete 2 and the long block of text after it.

This whole paragraph being in code formatting defeats the purpose of code formatting, as it is unable to emphasise that delete 2 is supposed to be user input from the user.

Makes the paragraph very hard to read as a whole.

This problem is seen in multiple places throughout the UG.

Many pages of the document break at some point that does not make much sense and breaks the smooth document flow.

This "examples:" should be on the same page as the examples.

This tip block should be together on the same page

Just a cosmetic flaw, but the table should begin on the next page so as to not have the headers of the table exist without any body.

Should be a thing, even if it's specified in your UG.

Event names should be able to contain all kinds of characters