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

Spelling #104

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

Spelling #104

wants to merge 11 commits into from

Conversation

jsoref
Copy link

@jsoref jsoref commented Feb 5, 2025

The PR template is missing "Updating the repository"...

This PR corrects misspellings identified by the check-spelling action

The misspellings have been reported at https://github.com/jsoref/infrastructure-actions/actions/runs/13163485276#summary-36737848728

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/infrastructure-actions/actions/runs/13163485493#summary-36737849208


I'm not proposing check-spelling for Apache. It doesn't fit w/ various criteria. But, I think fixing the typos here would be nice regardless.

jsoref added 11 commits February 5, 2025 12:45
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
@@ -10,7 +10,7 @@ jobs:
pelican-test:
env: # source and target branches
SOURCE: testsite
TARGET: testsite-${{ github.ref_name }} # each branch has own test output
TARGET: testsite-${{ github.ref_name }} # each branch has its own test output
Copy link
Author

Choose a reason for hiding this comment

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

This is a grammar error that I tripped on while looking at this workflow failure

@@ -179,15 +179,15 @@ def main():
parser.add_argument('-y', '--yaml', required=True, help="Pelicanconf YAML file")
args = parser.parse_args()

pelconf_yaml = args.yaml
sourcepath = os.path.dirname(os.path.realpath(pelconf_yaml))
pelicanconf_yaml = args.yaml
Copy link
Author

Choose a reason for hiding this comment

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

there's nothing horribly wrong w/ using short names, but there didn't seem to be a particularly good reason for it either.

@@ -50,7 +50,7 @@ def main():
with open(file, 'r', encoding='utf-8') as infile:
contents = infile.read()

# This will contain the "globals" after executing the peliconconf.py.
Copy link
Author

Choose a reason for hiding this comment

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

typos otoh ...

@@ -1,7 +1,7 @@
# Plugin Architecture

The plugins used operate at various points in a pelican build.
Pelican uses signals at various points. These are documented [here](https://docs.getpelican.com/en/latest/plugins.html#list-of-signals).
Pelican uses [signals](https://docs.getpelican.com/en/latest/plugins.html#list-of-signals) at various points.
Copy link
Author

Choose a reason for hiding this comment

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

This is an accessibility issue:

Do not use (click) here links

For more information, see:

(?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\()

it'd be really nice if Apache as a best practice blocked people from using (click) here links...

@dfoulks1 dfoulks1 requested a review from gstein April 1, 2025 11:44
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.

1 participant