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

Docs: Revise all docs mentioning Lua in EmuHawk (which are in English), and other misc. corrections #1782

Merged
merged 5 commits into from
Jun 26, 2023

Conversation

YoshiRulz
Copy link
Contributor

@YoshiRulz YoshiRulz commented May 1, 2023

What is this fixing or adding?

  • e183e16: Updates old links to TASVideos.org (http://tasvideos.org, *.html).
    • There are many other HTTP links in docs still. I suggest you update those where possible.
  • 939e163: Changes wording of tutorials for loading Lua scripts in EmuHawk to prioritise the drag+drop method over launching a file picker from the Lua Console.
  • 6d1f0b7 and 5877618: Minor branding nitpicks.

How was this tested?

N/A (URIs and error messages were untouched, identifiers were replaced across the whole codebase).

@black-sliver
Copy link
Member

black-sliver commented May 4, 2023

Thanks for the PR!

Re duplication/jinja. Markdown was a deliberate choice back in the day and it allows modification by less tech-savvy people. Jinja requires a local webhost while markdown can be pasted into a live preview and rendered on github.
The solution for duplicate text would be to put common text into a common markdown, but nobody found the time to do so yet.

Can you maybe elaborate here on where to use "EmuHawk" and where to use "BizHawk"? I would prefer to put "BizHawk" everywhere to avoid confusion, but if this is incorrect, I'd like to know exactly why.

Re branding nitpicks
branding

@black-sliver
Copy link
Member

black-sliver commented May 4, 2023

By the way

CBB

reads to me the same as your #NotOurProblem tag, which reads like F U. If you don't think it's necessary to post a screenshot, just don't.

@YoshiRulz
Copy link
Contributor Author

Can you maybe elaborate here on where to use "EmuHawk" and where to use "BizHawk"? I would prefer to put "BizHawk" everywhere to avoid confusion, but if this is incorrect, I'd like to know exactly why.

I cannot; we don't have branding guidelines yet. At this stage it's a personal vendetta of mine against phrases like "open the rom in BizHawk", which are technically ambiguous when we ship 2 apps, possibly more in the future. I've put that commit at the end so you can easily drop it.

[TASVideos.org wiki]

I'm aware of this, I just haven't gotten to it yet. There are also inconsistencies in the BizHawk codebase.

By the way, "CBB" reads to me the same as your #NotOurProblem tag, which reads like F U.

My apologies. And thank you for reminding me of that label, I agree it needs improvement.

@ThePhar ThePhar changed the title Revise all docs mentioning Lua in EmuHawk (which are in English), and other misc. corrections Docs: Revise all docs mentioning Lua in EmuHawk (which are in English), and other misc. corrections May 31, 2023
@ThePhar ThePhar added is: documentation Improvements or additions to documentation. is: refactor/cleanup Improvements to code/output readability or organizization. affects: core Issues/PRs that touch core and may need additional validation. labels May 31, 2023
Copy link

@shananas shananas left a comment

Choose a reason for hiding this comment

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

Changes LGTM. most of it being BizHawk Capitalization and changing references to use EmuHawk . Other big change preferring the user to drag and drop the script instead of loading through the BizHawk file picker.

Copy link
Collaborator

@t3hf1gm3nt t3hf1gm3nt left a comment

Choose a reason for hiding this comment

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

While i think the capitalization and references to EmuHawk are unecessary, I'm not gonna argue with one of the BizHawk devs about that. The rest of the changes to the guide are what I'm approving and desire to have added, as it adds the second method of loading scripts and, more importantly IMO, adds an update we forgot to do when we added support for 2.9+ about the lua core switching only being required in older BizHawk versions.

Copy link
Member

@black-sliver black-sliver left a comment

Choose a reason for hiding this comment

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

Changes render correctly on webhost. This was posted to our Discord for public review and no concerns were raised. Relaying the approval of shananas and figment (I personally don't use BizHawk) and merging before we get more conflicts.

@black-sliver black-sliver merged commit 1698c17 into ArchipelagoMW:main Jun 26, 2023
Zunawe pushed a commit to Zunawe/Archipelago that referenced this pull request Jun 30, 2023
…), and other misc. corrections (ArchipelagoMW#1782)

* Fix links to TASVideos.org using HTTP

* Revise all docs mentioning Lua in EmuHawk which are in English

resolves TASEmulators/BizHawk#3650

* Correct capitalisation of "BizHawk"

in strings and camelCase identifiers

* Use the term "EmuHawk" when referring to the app, in English docs

---------

Co-authored-by: black-sliver <[email protected]>
FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023
…), and other misc. corrections (ArchipelagoMW#1782)

* Fix links to TASVideos.org using HTTP

* Revise all docs mentioning Lua in EmuHawk which are in English

resolves TASEmulators/BizHawk#3650

* Correct capitalisation of "BizHawk"

in strings and camelCase identifiers

* Use the term "EmuHawk" when referring to the app, in English docs

---------

Co-authored-by: black-sliver <[email protected]>
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
…), and other misc. corrections (ArchipelagoMW#1782)

* Fix links to TASVideos.org using HTTP

* Revise all docs mentioning Lua in EmuHawk which are in English

resolves TASEmulators/BizHawk#3650

* Correct capitalisation of "BizHawk"

in strings and camelCase identifiers

* Use the term "EmuHawk" when referring to the app, in English docs

---------

Co-authored-by: black-sliver <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects: core Issues/PRs that touch core and may need additional validation. is: documentation Improvements or additions to documentation. is: refactor/cleanup Improvements to code/output readability or organizization.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants