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.

Sign up for GitHub

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

Jump to bottom

Broken link in asset system reference #607

Closed
pathunstrom opened this issue May 14, 2021 · 6 comments
Closed

Broken link in asset system reference #607

pathunstrom opened this issue May 14, 2021 · 6 comments
Labels
docs We need to add this to the docs. Hacktoberfest Good issues for Hacktoberfest (synced with new contributor) new contributor Apply to issues we think can be tackled by people new to PPB

Comments

@pathunstrom
Copy link
Collaborator

The reference to ppb.assets.Circle on https://ppb.readthedocs.io/en/stable/discussion/assets.html is not hyperlinkers properly.

This should probably reference Ellipse instead, but we also want the hyperlink to be generated.
@pathunstrom pathunstrom added new contributor Apply to issues we think can be tackled by people new to PPB docs We need to add this to the docs. labels May 14, 2021
@pathunstrom
Copy link
Collaborator Author

Same page AssetLoadingSystem is also not hyperlinked properly.

@pathunstrom
Copy link
Collaborator Author

Asset.free() is another one.

@pathunstrom
Copy link
Collaborator Author

The final load reference is broken as well.

@AstraLuma AstraLuma added the Hacktoberfest Good issues for Hacktoberfest (synced with new contributor) label Oct 1, 2021
@tran-dy tran-dy mentioned this issue Oct 1, 2021
Merged
@tran-dy
Copy link
Contributor

tran-dy commented Oct 1, 2021

Hi, I took a stab at correcting some of the links on this doc page.

Wasn't positive on how to proceed to correct for the AssetLoadingSystem reference since there didn't seem to be a section for that in the docs already.

Would that fit in as a section right before "General Asset Interface" section on this page (https://ppb.readthedocs.io/en/stable/reference/assets.html)?

bors bot added a commit that referenced this issue Oct 8, 2021
@bors @tran-dy @pathunstrom
Merge #639
511f9ce 
639: Fixed references to Ellipse, free(), and load() in Asset System reference r=pathunstrom a=tran-dy

Fixes for issue #607 

Updated the reference to Ellipse and load().
Added the free() method to the Asset reference page to fix the free() hyperlink.

Co-authored-by: Tran <6372167+tran-dy@users.noreply.github.com>
Co-authored-by: Andy Tran <6372167+tran-dy@users.noreply.github.com>
Co-authored-by: Piper Thunstrom <pathunstrom@gmail.com>
@ProsperousHeart
Copy link

Has this been completed?

@AstraLuma
Copy link
Member

Looks like!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs We need to add this to the docs. Hacktoberfest Good issues for Hacktoberfest (synced with new contributor) new contributor Apply to issues we think can be tackled by people new to PPB
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@AstraLuma @tran-dy @pathunstrom @ProsperousHeart