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

Add codespell: config + workflow (to catch new typos) + fix a number of typos using codespell #3474

Merged
merged 14 commits into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = .git,*.pdf,*.svg,*.lock,*.css,*.min.*,.codespellrc,releases,l10n,*.bundle.js,examples.txt*,./software/SchemaTerms/example-code/data,./data/ext/pending,./data/20*,bsdo-translation-examples.txt,protobufs
check-hidden = true
# some case sensitive hits and full regexes to ignore word compositions etc
ignore-regex = (^\s*"image/\S+": ".*|\b(INH|WEE|FOT|OCE|self.aks|readBy|Shepard)\b|https://schema.org/\S+|Couldn\\'t|\.FO|hel\\000lo|.*[éó].*)
ignore-words-list = ect,implementors,coo,implementor,reoccurrence
23 changes: 23 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Codespell configuration is within .codespellrc
---
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Codespell
uses: codespell-project/actions-codespell@v2
2 changes: 1 addition & 1 deletion data/ext/auto/auto.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
rdfs:label "BusOrCoach" ;
:isPartOf <https://auto.schema.org> ;
:contributor <https://schema.org/docs/collab/Automotive_Ontology_Working_Group> ;
rdfs:comment "A bus (also omnibus or autobus) is a road vehicle designed to carry passengers. Coaches are luxury busses, usually in service for long distance travel." ;
rdfs:comment "A bus (also omnibus or autobus) is a road vehicle designed to carry passengers. Coaches are luxury buses, usually in service for long distance travel." ;
rdfs:subClassOf :Vehicle .

:CarUsageType a rdfs:Class ;
Expand Down
2 changes: 1 addition & 1 deletion data/extdefs.jsonld
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
{
"@id": "http://attic.schema.org",
"schema:name": "Attic Area",
"schema:disambiguatingDescription": "these terms have been either deprecated from the core or extentions, or removed from [pending](/docs/howwework.html#pending) as not accepted into the full vocabulary.",
"schema:disambiguatingDescription": "these terms have been either deprecated from the core or extensions, or removed from [pending](/docs/howwework.html#pending) as not accepted into the full vocabulary.",
"schema:softwareVersion": "0.0",
"rdfs:comment": "The attic area is an archive area for terms which are no longer part of the core vocabulary or its extensions. _Attic_ terms are preserved here to satisfy previous links to them.\n\nImplementors and publishers are gently encouraged not to use terms in the attic area."
},
Expand Down
4 changes: 2 additions & 2 deletions data/schema.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -4710,7 +4710,7 @@ See also the <a href="/docs/hotels.html">dedicated document on the use of schema
:rangeIncludes :BroadcastFrequencySpecification,
:Text ;
:source <https://github.com/schemaorg/schemaorg/issues/1004> ;
rdfs:comment "The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. \"87 FM\"." .
rdfs:comment "The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequencies of AM and FM radio channels, e.g. \"87 FM\"." .

:broadcastFrequencyValue a rdf:Property ;
rdfs:label "broadcastFrequencyValue" ;
Expand Down Expand Up @@ -6553,7 +6553,7 @@ Typical unit code(s): MTK for square meter, FTK for square foot, or YDK for squa
rdfs:comment "Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group." .

# NOTE in data/ext/pending/issue-1797.ttl we tentatively amend this by extending the property as follows:
# The textual definition for isVariantOf has been minimally updated to accomodate ProductGroup; this could be
# The textual definition for isVariantOf has been minimally updated to accommodate ProductGroup; this could be
# :isVariantOf a rdf:Property ; :domainIncludes :Product ; :rangeIncludes :ProductGroup .

:isbn a rdf:Property ;
Expand Down
4 changes: 2 additions & 2 deletions data/sdo-creativework-examples.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ by <div itemprop="creator" itemscope itemtype="https://schema.org/Person">
depicts a church in <div itemprop="contentLocation" itemscope itemtype="https://schema.org/AdministrativeArea">
<span itemprop="name">Auvers-sur-Oise</span>,
</div>
but was creaetd in <div itemprop="locationCreated" itemscope itemtype="https://schema.org/AdministrativeArea">
but was created in <div itemprop="locationCreated" itemscope itemtype="https://schema.org/AdministrativeArea">
<span itemprop="name">Saint-Rémy-de-Provence</span>.
</div>
</div>
Expand All @@ -35,7 +35,7 @@ by <div property="creator" typeof="Person">
depicts a church in <div property="contentLocation" typeof="AdministrativeArea">
<span property="name">Auvers-sur-Oise</span>,
</div>
but was creaetd in <div property="locationCreated" typeof="AdministrativeArea">
but was created in <div property="locationCreated" typeof="AdministrativeArea">
<span property="name">Saint-Rémy-de-Provence</span>.
</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions data/sdo-lrmi-examples.txt
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ PRE-MARKUP:
includes major elements of a previously created original work. An
example of a derivative work is L.H.O.O.Q, or Mona Lisa With a Moustache,
by Marcel Duchamp.</p>
<p>Note: this defintion is based on the wikipedia article on Derivative
<p>Note: this definition is based on the wikipedia article on Derivative
Work</p>
</dd>
</dl>
Expand All @@ -330,7 +330,7 @@ MICRODATA:
An example of a derivative work is L.H.O.O.Q, or Mona Lisa With a Moustache,
by Marcel Duchamp.</p>
<p itemprop="isBasedOn" itemscope itemtype="https://schema.org/CreativeWork">
Note: this defintion is based on the <span itemprop="publisher">wikipedia</span>
Note: this definition is based on the <span itemprop="publisher">wikipedia</span>
article on <span itemprop="name">Derivative Work</span>
<link itemprop="url" href="https://en.wikipedia.org/wiki/Derivative_work" />
</p>
Expand All @@ -347,7 +347,7 @@ RDFA:
An example of a derivative work is L.H.O.O.Q, or Mona Lisa With a Moustache,
by Marcel Duchamp.</p>
<p property="isBasedOn" typeof="CreativeWork">
Note: this defintion is based on the <span property="publisher">wikipedia</span>
Note: this definition is based on the <span property="publisher">wikipedia</span>
article on <span property="name">Derivative Work</span>
<link property="url" href="https://en.wikipedia.org/wiki/Derivative_work" />
</p>
Expand Down
4 changes: 2 additions & 2 deletions data/sdo-offeredby-examples.txt
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ MICRODATA:
<meta itemprop="geoRadius" content="5000" />
</div>

with a minium order of $20.
with a minimum order of $20.
<div itemprop="priceSpecification" itemscope itemtype="https://schema.org/DeliveryChargeSpecification">
<meta itemprop="appliesToDeliveryMethod" link="http://purl.org/goodrelations/v1#DeliveryModeOwnFleet">
<div itemprop="eligibleTransactionVolume" itemscope itemtype="https://schema.org/PriceSpecification">
Expand All @@ -650,7 +650,7 @@ RDFA:
<span property="addressRegion">MA</span>
<span property="postalCode">02142</span>
</div>
delivers within 5 km of its store with a minium order of $20.
delivers within 5 km of its store with a minimum order of $20.
<div property="makesOffer" typeof="Offer">
<div property="priceSpecification" typeof="DeliveryChargeSpecification">
<meta property="appliesToDeliveryMethod" link="http://purl.org/goodrelations/v1#DeliveryModeOwnFleet">
Expand Down
2 changes: 1 addition & 1 deletion docs/cg/sdo-wot-tpac-2016-09.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ A: Large (and growing) collection of descriptive schemas, used primarily in the
Q: What kinds of descriptions?
A: Many! People, places, things, events, recipes, reviews, products, businesses, opening hours, creative works (books, articles etc.), many more.
Q: Where is it used?
A: Initially and primarily by search engines, but also sites like Pinterest, or iniatives like http://api.science.ai/ (scholarly publishing)
A: Initially and primarily by search engines, but also sites like Pinterest, or initiatives like http://api.science.ai/ (scholarly publishing)
Q: How big is it?
A: Core vocabulary currently has 583 types, 846 properties, and 114 Enumeration values. More in extension sections.

Expand Down
6 changes: 3 additions & 3 deletions docs/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ <h1>About Schema.org</h1>

<p><a href="faq.html#17">Where did you get that great domain name?</a></p>

<p><a href="faq.html#18">Under what terms can we re-use this documentation?</a></p>
<p><a href="faq.html#18">Under what terms can we reuse this documentation?</a></p>

<p><a href="faq.html#19">Should we write 'https://schema.org' or 'http://schema.org' in our markup?</a></p>

Expand Down Expand Up @@ -168,12 +168,12 @@ <h1>About Schema.org</h1>

<p class="question">Q:
<a name="18"
id="18"></a>Under what terms can we re-use this documentation (and schemas, examples, software)?</p>
id="18"></a>Under what terms can we reuse this documentation (and schemas, examples, software)?</p>
<p>As noted in our <a href="https://schema.org/docs/terms.html">terms of service</a> document, schema.org schemas
are made available under the <a href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike License (version 3.0)</a>.
These terms also apply to the supporting <a href="https://schema.org/docs/documents.html">documentation</a> on this site and
on our <a href="http://blog.schema.org/">blog</a>, as well as to the markup examples used in this site. The software used for our site is also
<a href="https://github.com/schemaorg/schemaorg/blob/main/software/SOFTWARE_README.md">available</a> for opensource re-use under an
<a href="https://github.com/schemaorg/schemaorg/blob/main/software/SOFTWARE_README.md">available</a> for opensource reuse under an
<a href="https://github.com/schemaorg/schemaorg/blob/main/LICENSE">Apache 2</a> license. If you have feedback on these terms please <a href="feedback.html">get in touch</a>.
</p>

Expand Down
2 changes: 1 addition & 1 deletion docs/iot-gettingstarted.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ <h2>Appendix A: Schema Survey: Related Works</h2>

<h3>IETF</h3>
<p>The IETF work on the Internet of Things crosses a number of different IETF Areas, and is coordinated by a <a href="https://trac.tools.ietf.org/area/int/trac/wiki/IOTDirWiki">recently constituted directorate</a>. The work includes a variety of application, security, routing, and addressing elements; related working groups include <a href="https://datatracker.ietf.org/wg/ace/charter/">ACE</a>, <a href="https://datatracker.ietf.org/wg/roll/charter/">ROLL</a>, <a href="https://datatracker.ietf.org/wg/6lo/charter/">6lo</a>, <a href="https://datatracker.ietf.org/wg/homenet/documents/">homenet</a>,<a href="https://datatracker.ietf.org/wg/homenet/documents/"> lwig</a>, <a href="https://datatracker.ietf.org/wg/6tisch/charter/">6TiSCH</a> and <a href="https://datatracker.ietf.org/wg/core/charter/">CoRE</a>. Because the work draws on existing IETF specifications and experience, it is also common for constrained device considerations to be present in other groups, even if it is not their main focus. The general thrust of IETF work is to ensure that constrained devices participate as fully in the Internet as is practical and to identify responses to those constraints that work well in the overall environment. See the recent <a href="https://www.internetsociety.org/publications/ietf-journal-april-2016/internet-things-standards-and-guidance-ietf">overview document</a>, "Internet of Things: Standards and Guidance from the IETF" for more details.</p>
<p>In addition to the work on standards specification, there is related work in the Internet Research Task Force, primarily concentrated in the <a href="https://irtf.org/t2trg">Thing-to-Thing Research Group</a> <a href="https://irtf.org/t2trg">(T2TRG)</a>. Working in close collaboration with the W3C's Web of Things group, the T2TRG focuses on longer term research issues on IoT, with current work centering around RESTful design / hypermedia-driven applications and security. The IRTF work is coordinated by the Internet Architecture Board, which has also held a number of workshops related to the Internet of Things. Two recent workshops focused on <a href="https://www.iab.org/activities/workshops/iotsi/">Semantic Interoperabilit</a>y and <a href="https://www.iab.org/activities/workshops/iotsu/">Software Updat</a>e practices for IoT. </p>
<p>In addition to the work on standards specification, there is related work in the Internet Research Task Force, primarily concentrated in the <a href="https://irtf.org/t2trg">Thing-to-Thing Research Group</a> <a href="https://irtf.org/t2trg">(T2TRG)</a>. Working in close collaboration with the W3C's Web of Things group, the T2TRG focuses on longer term research issues on IoT, with current work centering around RESTful design / hypermedia-driven applications and security. The IRTF work is coordinated by the Internet Architecture Board, which has also held a number of workshops related to the Internet of Things. Two recent workshops focused on <a href="https://www.iab.org/activities/workshops/iotsi/">Semantic Interoperabilit</a>y and <a href="https://www.iab.org/activities/workshops/iotsu/">Software Update</a> practices for IoT. </p>

<h3>W3C</h3>
<p>W3C has a few specifications that cover IoT-related considerations relating to the Web platform, as well as an initiative exploring "Web of Things":</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/kickoff.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ <h1>Schema.org Workshop</h1>
<h2>September 21, 2011, Mountain View, California</h2>


<p>Google, Microsoft, and Yahoo hosted about 75 representatives from the web standards, web publishing, and content tools communities for a day-long workshop with the purpose of soliciting feedback and input, evolving the schema.org specification towards a 1.0 spec, and building momemtum for implementation.</p>
<p>Google, Microsoft, and Yahoo hosted about 75 representatives from the web standards, web publishing, and content tools communities for a day-long workshop with the purpose of soliciting feedback and input, evolving the schema.org specification towards a 1.0 spec, and building momentum for implementation.</p>

<p>Here are slides from the day:</p>

Expand Down
4 changes: 2 additions & 2 deletions docs/releases.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h1>Releases</h1>
<td>
<ul>
<li id="g2858"><a href="https://github.com/schemaorg/schemaorg/issues/2858">Issue #2858</a>: Added <a href="/agentInteractionStatistic">agentInteractionStatistic</a> to provide a way of counting interactions where the item of interest is in an "agent" rather than "object" role on the relevant Action.</li>
<li id="g3376"><a href="https://github.com/schemaorg/schemaorg/issues/3376">Issue #3376</a>: Provided a clearer way to indicate non-Comment items that Comments are attached to, by documenting the use of <a href="/parentItem">parentItem</a> on <a href="/CreativeWork">CreativeWork</a> in general. Also made it more explicit that this is especially applicable to those creative works beneath <a href="/Comment">Comment</a> in the type hiearchy which are mentioned in the definition, i.e. <a href="/Question">Question</a> and <a href="/Answer">Answer</a>.</li>
<li id="g3376"><a href="https://github.com/schemaorg/schemaorg/issues/3376">Issue #3376</a>: Provided a clearer way to indicate non-Comment items that Comments are attached to, by documenting the use of <a href="/parentItem">parentItem</a> on <a href="/CreativeWork">CreativeWork</a> in general. Also made it more explicit that this is especially applicable to those creative works beneath <a href="/Comment">Comment</a> in the type hierarchy which are mentioned in the definition, i.e. <a href="/Question">Question</a> and <a href="/Answer">Answer</a>.</li>
<li id="g3389"><a href="https://github.com/schemaorg/schemaorg/issues/3389">Issue #3389</a>: Added <a href="/Comment">Comment</a> to the domain of <a href="/sharedContent">sharedContent</a> to better support link shares on replies/comments even though a lot of sites now support this.</li>
<li id="g3390"><a href="https://github.com/schemaorg/schemaorg/issues/3390">Issue #3390</a>: Expanded range of <a href="/uploadDate">uploadDate</a> to include <a href="/DateTime">DateTime</a>, correcting a longstanding bug.</li>
<li id="g3347"><a href="https://github.com/schemaorg/schemaorg/issues/3347">PR #3347</a>: Improved error reporting in case the parsing of JSON-LD examples fails.</li>
Expand Down Expand Up @@ -270,7 +270,7 @@ <h1>Releases</h1>
<li id="g3065"><a href="https://github.com/schemaorg/schemaorg/pull/3065">PR #3065</a>: Added an example of ESIP Science-On-Schema markup to <a href="/Dataset">Dataset</a> and <a href="/ResearchProject">ResearchProject</a>.</li>
<li id="g2859"><a href="https://github.com/schemaorg/schemaorg/pull/2859">PR #2859</a>: Added <a href="/PerformanceRole">PerformanceRole</a> example <a href="/actor">actor</a> property.</li>
<li id="g3298"><a href="https://github.com/schemaorg/schemaorg/issues/3298">Issue #3298</a>: Corrected priceCurrency examples in <a href="/Offer">Offer</a> examples.</li>
<li id="g3303"><a href="https://github.com/schemaorg/schemaorg/issues/3303">Issue #3303</a>: Added <a href="/bed">bed</a> and <a href="/occupancy">occupancy</a> to <a href="/Accommodation">Accomodation</a> and added a subtype of <a href="/LodgingBusiness">LodgingBusiness</a> called <a href="/VacationRental">VacationRental</a>.</li>
<li id="g3303"><a href="https://github.com/schemaorg/schemaorg/issues/3303">Issue #3303</a>: Added <a href="/bed">bed</a> and <a href="/occupancy">occupancy</a> to <a href="/Accommodation">Accommodation</a> and added a subtype of <a href="/LodgingBusiness">LodgingBusiness</a> called <a href="/VacationRental">VacationRental</a>.</li>
</ul>
<h3>Changes in new area:</h3>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion software/RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ POST-RELEASE STEPS

* Tag gitub version vXX.X-release

`git tag [tagname] [commmit code]`
`git tag [tagname] [commit code]`

eg. `git tag v14.0-release 9d691a8` Note capitalisation

Expand Down
2 changes: 1 addition & 1 deletion software/SOFTWARE_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ If when running local scripts you receive an error of this form:

ModuleNotFoundError: No module named 'module_name'

There are two common causes. Either your Python environment is not correctly set to 3.10 or above, or it does not contain all the required modules which may be because new dependencies have been added or changed. To confirm you have the correct modules loaded, run again the cmmand:
There are two common causes. Either your Python environment is not correctly set to 3.10 or above, or it does not contain all the required modules which may be because new dependencies have been added or changed. To confirm you have the correct modules loaded, run again the command:

pip install -r software/requirements.txt

Expand Down
2 changes: 1 addition & 1 deletion software/SchemaExamples/example-code/out
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ RDFA:
</div>
<div typeof="DefinedTerm">
<h2>Dictionary term</h2>
<link propery="url" href="http://openjurist.org/dictionary/Ballentine/term/schema"/>
<link property="url" href="http://openjurist.org/dictionary/Ballentine/term/schema"/>
Name: <span property="name">schema</span><br/>
Description: <span property="description">A representation of a plan or theory in the form of an outline or model.</span><br/>
In Dictionary: Ballentine&apos;s Law Dictionary
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
# or expanded (nested definitions for related terms)

def templateRender(term):
#Basic varibles configuring UI
#Basic variables configuring UI
tvars = {
'sitename': "SchemaTerms",
'menu_sel': "Schemas",
Expand Down