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

Update pkgdown #1043

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Update pkgdown #1043

wants to merge 3 commits into from

Conversation

Jennit07
Copy link
Collaborator

No description provided.

Copy link

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (2)

SPSS
yml

These words are not needed and should be removed anomymous datas javascript netlify noreply nwtgck scoial spss

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:Public-Health-Scotland/source-linkage-files.git repository
on the update_pkgdown branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/Public-Health-Scotland/source-linkage-files/actions/runs/12767785233/attempts/1'

OR

To have the bot accept them for you, comment in the PR quoting the following line:
@check-spelling-bot apply updates.

Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (313) from .github/actions/spelling/expect.txt and unrecognized words (2)

Dictionary Entries Covers Uniquely
cspell:k8s/dict/k8s.txt 153 4 1
cspell:npm/dict/npm.txt 302 3
cspell:php/dict/php.txt 1689 3
cspell:python/src/python/python-lib.txt 2417 3
cspell:fullstack/dict/fullstack.txt 419 2 2

Consider adding them (in .github/workflows/spelling.yml) in jobs:/spelling: for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries: |
          cspell:k8s/dict/k8s.txt
          cspell:npm/dict/npm.txt
          cspell:php/dict/php.txt
          cspell:python/src/python/python-lib.txt
          cspell:fullstack/dict/fullstack.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''
Errors (1)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors Count
❌ ignored-expect-variant 3

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

@Jennit07 Jennit07 self-assigned this Jan 23, 2025
@lizihao-anu
Copy link
Collaborator

Why do we do this though? Does anything malfunction or is it out of date?

@Jennit07
Copy link
Collaborator Author

Why do we do this though? Does anything malfunction or is it out of date?

This is related to the website i was sharing on the call. The main purpose/nice feature of this is there is a reference tab which links to all of the documentation for every function in the package. The Readme page is also out of date so it would be good to get things updated/more documentation on the package. If you look at the SLFhelper package website, it also has vignettes where we added memory consumption documentation. The idea is the same to have this available for the createslf package. Happy to discuss further if needed as this took me a while to figure out to get it working again. The link was initially broken/not updated in some time

@lizihao-anu
Copy link
Collaborator

Why do we do this though? Does anything malfunction or is it out of date?

This is related to the website i was sharing on the call. The main purpose/nice feature of this is there is a reference tab which links to all of the documentation for every function in the package. The Readme page is also out of date so it would be good to get things updated/more documentation on the package. If you look at the SLFhelper package website, it also has vignettes where we added memory consumption documentation. The idea is the same to have this available for the createslf package. Happy to discuss further if needed as this took me a while to figure out to get it working again. The link was initially broken/not updated in some time

Great!

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

Successfully merging this pull request may close these issues.

2 participants