Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change See Also section #625

Closed
tjingboem opened this issue Jul 29, 2022 · 6 comments
Closed

change See Also section #625

tjingboem opened this issue Jul 29, 2022 · 6 comments
Assignees

Comments

@tjingboem
Copy link
Member

tjingboem commented Jul 29, 2022

Regarding the See Also section:
a lot of times related opcodes are not present, and often because a related opcode was created after an opcode and this list was not updated.

A better solution would be to change the See Also section to have a link to that group of opcodes as mentioned in the Opcodes Overview section. This list is kept up to date.
From there, the user can hop to a few opcodes of which he/she thinks is the most appropriate for the case he/she is working on. And hop back if this turns out not to be the correct one after all.

Adding all related opcodes to a manual page clutters the screen IMO

For table this See Also section would get a link to:
Screenshot from 2022-07-29 11-48-08

@joachimheintz
Copy link
Contributor

joachimheintz commented Aug 4, 2022 via email

@tjingboem
Copy link
Member Author

tjingboem commented Aug 5, 2022

Right.
And another nice side effect is that the opcodes Overview gets really tight in with the opcode manual pages- giving it even more meaning.

If this Part II. Opcodes Overview is kept up to date, the user that is looking on a manual page for a certain opcode, will likely find the relevant opcode faster.

@tjingboem tjingboem self-assigned this Aug 8, 2022
@csounder
Copy link

This would be wonderful. I am always looking for, and checking out, the related opcodes at the bottom of each manpage - this might be an even more effective and helpful solution.

@tjingboem
Copy link
Member Author

tjingboem commented Aug 30, 2022

@csounder
Copy link

csounder commented Aug 30, 2022 via email

@tjingboem
Copy link
Member Author

i think it will be ready for 7.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants