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

HK: use rich_text_options_doc to make webhost formatting look better #4079

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

qwint
Copy link
Contributor

@qwint qwint commented Oct 21, 2024

What is this fixing or adding?

switch to using restructured text on webhost so they don't see the yaml line breaks in option docstrings

How was this tested?

opened webhost, didn't see line breaks in randomizeskills and randomizewhisperingroots in both options and weighted options pages
generated template yamls and saw the line breaks

If this makes graphical changes, please attach screenshots.

ap.gg
image

this branch
image

@github-actions github-actions bot added the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label Oct 21, 2024
@Exempt-Medic Exempt-Medic added is: enhancement Issues requesting new features or pull requests implementing new features. is: documentation Improvements or additions to documentation. labels Oct 22, 2024
@Exempt-Medic
Copy link
Collaborator

Exempt-Medic commented Oct 22, 2024

Some options that, to me, look worse after these changes:
"Grub Hunt Goal", "Randomized Charm Notch Costs", and "Costsanity" now all describe their specific values in the same paragraph as the general description.
"White Palace" has two spaces after a period now.
Maybe "Randomize Lore Tablets" and "Minimum/Maximum Egg Price", where the final sentences are no longer on their own lines.

"Death Link Shade Handling" (Death Link Breaks Fragile Charms has a similar problem):
Screenshot 2024-10-21 210555
(The error is also shown in the console when running WebHost)

@Exempt-Medic Exempt-Medic added the waiting-on: author Issue/PR is waiting for feedback or changes from its author. label Oct 22, 2024
@qwint
Copy link
Contributor Author

qwint commented Oct 22, 2024

hm yea, those will either have to be rewritten to follow the new format or have their individual Option.rich_text_doc turned off (which should work to my knowledge),,

…nt in rst, not super happy with how it changes yaml descriptions but they're readable
@qwint
Copy link
Contributor Author

qwint commented Oct 27, 2024

world setting takes precedent (as a bug) so had to just recreate intent in rst, not super happy with how it changes yaml descriptions but they're readable

@qwint
Copy link
Contributor Author

qwint commented Oct 27, 2024

said bug is now fixed, don't know if i want to revert the per-option text changes or not though,

Copy link
Collaborator

@Exempt-Medic Exempt-Medic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Things LGTM. It's worth noting that this impacts the advanced options page, but that page is already so poorly formatted that it getting worse doesn't hurt:

Screenshot 2024-10-28 093337

Screenshot 2024-10-28 093239

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation. is: enhancement Issues requesting new features or pull requests implementing new features. waiting-on: author Issue/PR is waiting for feedback or changes from its author. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants