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

Typo Error in Documentation: Incorrect Hyperlink in Launching Pad Sec… #525

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Haleshot
Copy link

@Haleshot Haleshot commented Mar 2, 2024

Description

I found a typo in the documentation listed on the main page (https://pyswarms.readthedocs.io/en/latest/) under the Launching Pad section. The hyperlink provided to use-cases examples is incorrect.

Related Issue

Fixes #524

Motivation and Context

Just fixing a typo in the landing page of the documentation to try out use cases.

How Has This Been Tested?

Removed the examples from the hyperlink and the webpage redirects to use cases correctly.

Screenshots (if appropriate):

Error_404_Page

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

…tion

## Description
<!--- Describe your changes in detail -->
I found a typo in the documentation listed on the main page (https://pyswarms.readthedocs.io/en/latest/) under the Launching Pad section. The hyperlink provided to `use-cases examples` is incorrect.

## Related Issue
Fixes ljvmiranda921#524

## Motivation and Context


## How Has This Been Tested?
Removed the `examples` from the hyperlink and the webpage redirects to use cases correctly.

## Screenshots (if appropriate):

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

Fixes ljvmiranda921#524 <!--- Replace 524 with the appropriate issue number -->
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.

Typo Error in Documentation: Incorrect Hyperlink for use case examples in Launching Pad Section
1 participant