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

Fix: Fixed the broken link in "contributor_docs/fes_contribution_guide.md" file #7307

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

Conversation

poswalsameer
Copy link

PR Description:
This PR solves the issue of the broken link which is present in contributor_docs/fes_contribution_guide.md. Now, it is getting redirected to the right link.

Resolves #7227

Changes:
This PR changes only a single file fes_contribution_guide.md which can be found inside the folder contributor_docs.

Screenshots of the change:
Screenshot not required.

PR Checklist

Copy link
Contributor

@perminder-17 perminder-17 left a comment

Choose a reason for hiding this comment

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

Thanks for working at this issue. Looks good to me. I was little confused with the link because it was talking specifically about "Friendly Error perfomance test" and the link of the file you added was redirecting to the whole documentation of it.

But since we used the same link here https://github.com/processing/p5.js/wiki/Optimizing-p5.js-Code-for-Performance#p5-performance-tips , I think it's good to use the same link you currently added. So thanks:)

@Qianqianye
Copy link
Contributor

Thanks @poswalsameer and @perminder-17!
Hi @limzykenneth, do you have any thoughts on where the 'Friendly Error performance test' link is supposed to go?

@limzykenneth
Copy link
Member

I think we can leave out that line entirely as the following info is already providing actionable information.

@@ -484,7 +484,7 @@ The functionality described under `fesErrorMonitor()` currently only works on th

### Performance Issue with the FES

By default, FES is enabled for p5.js and disabled in `p5.min.js` to prevent FES functions from slowing down the process. The error-checking system can significantly slow down your code (up to \~10x in some cases). See the [Friendly Error performance test](https://github.com/processing/p5.js-website/tree/main/src/assets/learn/performance/code/friendly-error-system).
By default, FES is enabled for p5.js and disabled in `p5.min.js` to prevent FES functions from slowing down the process. The error-checking system can significantly slow down your code (up to \~10x in some cases). See the [Friendly Error performance test](https://github.com/processing/p5.js/blob/main/contributor_docs/friendly_error_system.md).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
By default, FES is enabled for p5.js and disabled in `p5.min.js` to prevent FES functions from slowing down the process. The error-checking system can significantly slow down your code (up to \~10x in some cases). See the [Friendly Error performance test](https://github.com/processing/p5.js/blob/main/contributor_docs/friendly_error_system.md).
By default, FES is enabled for p5.js and disabled in `p5.min.js` to prevent FES functions from slowing down the process. The error-checking system can significantly slow down your code (up to \~10x in some cases).

Copy link
Contributor

Choose a reason for hiding this comment

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

Makes sense. Thanks

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

Successfully merging this pull request may close these issues.

Fix broken links in contributor_docs/fes_contribution_guide.md
4 participants