codespell: add codespell config, workflow and some typos fixed by yarikoptic · Pull Request #2470 · zenodo/zenodo

yarikoptic · 2023-08-30T14:34:24Z

workflow would detect new typos if they are introduced. No magical fixing would happen behind your shoulders.

Thanks for the zenodo!

yarikoptic · 2023-08-30T14:44:31Z

        "id": "cc-by-sa"
      }, 
-      "description": "<p><strong>Project Specification</strong></p>\n\n<p>The aim of this openlab summer student project is to enhance ZENODO digital repository service with several preservation-oriented features, such as preservation meter and badge to indicate the&nbsp;suitability of a document for long-term reservation. The project will be developed in the Python&nbsp;programming language, using Flask/HTML5/jQuery/TwitterBootstrap technologies for the user&nbsp;interface and SQLAlchemy/MySQL for persistence.</p>\n\n<p><strong>Abstract</strong></p>\n\n<p>Digital Preservation consists mainly in storing digital information, mostly digital-born content,&nbsp;and making sure that it remains available and accessible in the future. This tasks has many&nbsp;challenges such as making sure that the files are in a known and acessible format, that they are&nbsp;not corrupt, lost or unretrievable.&nbsp;The digital preservation challenges apply, noticeably, on digital repositories such as Zenodo.&nbsp;Zenodo aims to provide a secure and trusty way of storing data for the long tail of science. This is&nbsp;to say, storing and connecting information that is normally not available on the main publications,&nbsp;such as the used datasets for a given study or the produced software for a specific paper.&nbsp;The goal of this work was to develop a Preservation Meter that allowed the users to know how&nbsp;suitable the files on their submitted records are in terms of preservation.This was accomplished by using a simple and intuitive visual representation of such suitability by&nbsp;means of a progress bar, where a completely filled bar means the file is very likely to be well&nbsp;preserved.&nbsp;The overall goals of the project were completed and the implementation of this work was&nbsp;integrated on the Zenodo repository as a plugin.</p>", 
+      "description": "<p><strong>Project Specification</strong></p>\n\n<p>The aim of this openlab summer student project is to enhance ZENODO digital repository service with several preservation-oriented features, such as preservation meter and badge to indicate the&nbsp;suitability of a document for long-term reservation. The project will be developed in the Python&nbsp;programming language, using Flask/HTML5/jQuery/TwitterBootstrap technologies for the user&nbsp;interface and SQLAlchemy/MySQL for persistence.</p>\n\n<p><strong>Abstract</strong></p>\n\n<p>Digital Preservation consists mainly in storing digital information, mostly digital-born content,&nbsp;and making sure that it remains available and accessible in the future. This tasks has many&nbsp;challenges such as making sure that the files are in a known and accessible format, that they are&nbsp;not corrupt, lost or unretrievable.&nbsp;The digital preservation challenges apply, noticeably, on digital repositories such as Zenodo.&nbsp;Zenodo aims to provide a secure and trusty way of storing data for the long tail of science. This is&nbsp;to say, storing and connecting information that is normally not available on the main publications,&nbsp;such as the used datasets for a given study or the produced software for a specific paper.&nbsp;The goal of this work was to develop a Preservation Meter that allowed the users to know how&nbsp;suitable the files on their submitted records are in terms of preservation.This was accomplished by using a simple and intuitive visual representation of such suitability by&nbsp;means of a progress bar, where a completely filled bar means the file is very likely to be well&nbsp;preserved.&nbsp;The overall goals of the project were completed and the implementation of this work was&nbsp;integrated on the Zenodo repository as a plugin.</p>", 


here typo was acessible

yarikoptic · 2023-08-30T14:44:59Z

        "id": "cc-by-sa"
      }, 
-      "description": "<p>&nbsp;&nbsp;Abstract</p>\n\n<p>WinCC OA is a SCADA (Supervisory Control and Data Acquisition) system tool that is used to develop the Control System applications. As most of the control systems used in CERN are developed in WinCC OA, it is better useful to understand how the applications developed by EN/ICE are actually used by the different operators .It becomes more and more important to monitor users&rsquo; behavior and analyzing it. The final goal of this project is to develop a generic WinCC OA component to collect data about user interaction which will take advantage of (1) the internal mechanisms already present in WinCC OA to monitor some user interactions such as the internal UI data points; and (2) the commonalities of applications through the use of the standard frameworks JCOP, UNICOS and CPC. The final component developed provides the capability of storing as well as displaying user interaction data on a single timeline.</p>\n\n<p>Kewords: WinCC OA, SCADA, JCOP, UNICOS, CPC</p>", 
+      "description": "<p>&nbsp;&nbsp;Abstract</p>\n\n<p>WinCC OA is a SCADA (Supervisory Control and Data Acquisition) system tool that is used to develop the Control System applications. As most of the control systems used in CERN are developed in WinCC OA, it is better useful to understand how the applications developed by EN/ICE are actually used by the different operators .It becomes more and more important to monitor users&rsquo; behavior and analyzing it. The final goal of this project is to develop a generic WinCC OA component to collect data about user interaction which will take advantage of (1) the internal mechanisms already present in WinCC OA to monitor some user interactions such as the internal UI data points; and (2) the commonalities of applications through the use of the standard frameworks JCOP, UNICOS and CPC. The final component developed provides the capability of storing as well as displaying user interaction data on a single timeline.</p>\n\n<p>Keywords: WinCC OA, SCADA, JCOP, UNICOS, CPC</p>", 


here typo was Kewords:

yarikoptic · 2023-08-30T14:45:34Z

        "id": "cc-by-sa"
      }, 
-      "description": "<p><strong>Project Specification</strong></p>\n\n<p>The project concerns various C++11 features - their performance and reliability. The report summarizes the tesults from four micro-benchmarks designed for this project and run with three different compilers (GCC, ICC, Clang) and tries to make an evaluation based on the results.</p>\n\n<p><strong>Abstract</strong></p>\n\n<p>As C++11 gained almost full support by compilers, it is interesting to see whether we can leverage some of the features to improve performance and reliability of C++ code. This work is focused on four selected problems: time measurement techniques, for-loops efficiency, asynchronous tasks and parallel mode of STL algorithms. For each of them a micro-benchmark is made. All the benchmarks are fully automatized to generate results from running binaries compiled by three compilers: GCC, ICC and Clang with -O2, -O3 and -Ofast options. In order to evaluate vectorization and multithreading, profiling tools such as perf and Intel Vtune are used.</p>", 
+      "description": "<p><strong>Project Specification</strong></p>\n\n<p>The project concerns various C++11 features - their performance and reliability. The report summarizes the tesults from four micro-benchmarks designed for this project and run with three different compilers (GCC, ICC, Clang) and tries to make an evaluation based on the results.</p>\n\n<p><strong>Abstract</strong></p>\n\n<p>As C++11 gained almost full support by compilers, it is interesting to see whether we can leverage some of the features to improve performance and reliability of C++ code. This work is focused on four selected problems: time measurement techniques, for-loops efficiency, asynchronous tasks and parallel mode of STL algorithms. For each of them a micro-benchmark is made. All the benchmarks are fully automated to generate results from running binaries compiled by three compilers: GCC, ICC and Clang with -O2, -O3 and -Ofast options. In order to evaluate vectorization and multithreading, profiling tools such as perf and Intel Vtune are used.</p>", 


here was automatized replaced to automated... I guess could be added to skips if really desired

=== Do not change lines below === { "chain": [], "cmd": "codespell -w -i 3 -C 2", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^

=== Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^

musvaage · 2023-11-22T21:16:34Z

here was automatized replaced to automated... I guess could be added to skips if really desired

zenodo/modules/fixtures/data/records.json

looks like @lnielsen in #475 initially submitted and merged that file

possibly the author's intention in that file was offers rather than offsers

Seagate Kinetic offsers ethernet enabled disk drives

@musvaage

A sharp eye of the @musvaage spotted it in zenodo/zenodo#2470 . And indeed github search gives 460 hits ATM https://github.com/search?q=offsers&type=code and they look like legit typos. Typo is really close to offser->offset one, but upon quick github search I never found offser to be a typo for offer. I think that spurious "s" in offsers is mechanical, and thus I did not bother adding second variant for "offser" typo to be offer

…ore where intentional typo made

=== Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^

yarikoptic · 2023-11-22T22:42:07Z

possibly the author's intention in that file was offers rather than offsers

nice catch!

filed Add typo offsers codespell-project/codespell#3232
pushed fix running that adjusted codespell, after adding handling of inline pragma to ingore intentional typo in the test

@musvaage

A sharp eye of the @musvaage spotted it in zenodo/zenodo#2470 . And indeed github search gives 460 hits ATM https://github.com/search?q=offsers&type=code and they look like legit typos. Typo is really close to offser->offset one, but upon quick github search I never found offser to be a typo for offer. I think that spurious "s" in offsers is mechanical, and thus I did not bother adding second variant for "offser" typo to be offer

musvaage · 2023-12-16T16:02:09Z

cf: #2476 (comment)

Modifying description fields in records.json may seem innocuous.
...
@mitsosf, @ppanero

In retrospect if any of the description fields modified in #2423 (Closed) should be reverted this can be pursued.

More specifically developer input on the purpose of modifying the description fields should be forthcoming!

Indeed, is there any 'public exposure' of such zenodo hosted "Abstract"(s) aside from those appearing on the specified URLs?

If not, there would appear to be NO reason to modify those description fields.

I am happy to submit a PR reverting specific changes implemented in #2423 (Closed).

$ grep -nr loaddemorecords zenodo
zenodo/zenodo/modules/fixtures/cli.py:46:from .records import loaddemorecords, loadsipmetadatatypes
zenodo/zenodo/modules/fixtures/cli.py:115:@fixtures.command('loaddemorecords')
zenodo/zenodo/modules/fixtures/cli.py:120:def loaddemorecords_cli(records_file=None, owner=None):
zenodo/zenodo/modules/fixtures/cli.py:129:        loaddemorecords(records, owner)
zenodo/zenodo/modules/fixtures/records.py:42:def loaddemorecords(records, owner):
$

$ ed -s zenodo/zenodo/modules/fixtures/cli.py <<<'116,117p'
@click.option('--records-file', type=click.File(),
              default=join(dirname(__file__), 'data/records.json'))
$

My sympathies at this point is to scrap this PR.

A new PR implementing exclusively the herein exposed typos occurring in the .html file and the .py files might be made.

That approach would obviously not modify tests/unit/deposit/test_api_metadata.py.

Adding codespell content to this repo seems to me to be over the top.

yarikoptic · 2023-12-16T19:52:30Z

My sympathies at this point is to scrap this PR.

really not sure what exactly motivation to scrap this PR since it fixes "legit" typos in a number of files/locations. If you would like to keep records.json not modified - I can skip it, just tell me so.

musvaage · 2023-12-17T17:06:05Z

motivation to scrap this PR

cf: #2476 (comment)

I'd have approached the subject matter of #2470 differently.

an Issue soliciting Maintainer opinion on adding a workflow to detect new typos if they are introduced

a separate Pull Request fixing the spell-checker identified and other typos

FWIW, the majority of the commits to this repo appear to be 2 to 8 years old.

To elaborate on my previous comment to this current PR.

Adding codespell content to this repo seems to me to be over the top.

IMHO, the proposed workflow isn't justified owing to the frequency of new textual content being added to this repo.

yarikoptic · 2023-12-18T14:53:15Z

Adding codespell content to this repo seems to me to be over the top.

IMHO, the proposed workflow isn't justified owing to the frequency of new textual content being added to this repo.

oh well, I guess we have different opinions about such automations - I tend to automate anything which could save humans some time at the cost of some negligible compute (in particular the free one). Feel welcome to scrap this PR then.

musvaage · 2023-12-18T21:53:25Z

@lnielsen

I am happy to submit a PR reverting specific changes implemented in #2423 (Closed).

As a Member would you voice an opinion on whether changes to records.json in #2423 (Closed) should be reverted?

Factually I believe those changes to records.json should be reverted.

Separately might be clarified the Maintainer/Member consensus on whether or not to add this OP's proposed workflow.

slint · 2024-02-20T16:00:23Z

Unfortunately, I will have to close this PR to prevent unnecessary work from being done in this repository for the time being. See my detailed response at #2519 (comment)

yarikoptic added 3 commits August 30, 2023 10:26

Add github action to codespell master on push and PRs

7c9ba66

Add rudimentary codespell config

aa90ca2

ignore some files

d857cf2

yarikoptic commented Aug 30, 2023

View reviewed changes

Comment thread zenodo/modules/fixtures/data/funders.json Outdated

yarikoptic added 3 commits August 30, 2023 10:46

[DATALAD RUNCMD] Do interactive fixing of some ambigous typos

a5b54f5

=== Do not change lines below === { "chain": [], "cmd": "codespell -w -i 3 -C 2", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^

ignore funders since could have many acronyms etc

8a26918

[DATALAD RUNCMD] run codespell throughout fixing 1 new typo

2aa4813

=== Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^

yarikoptic force-pushed the enh-codespell branch from 4d1dd24 to 2aa4813 Compare August 30, 2023 14:47

afuetterer mentioned this pull request Sep 24, 2023

chore: fix typos #2476

Closed

yarikoptic mentioned this pull request Nov 22, 2023

Add typo offsers codespell-project/codespell#3232

Merged

yarikoptic added 2 commits November 22, 2023 17:41

Provision codespell-ignore inline pragma to ignore such lines and ign…

b7d3169

…ore where intentional typo made

[DATALAD RUNCMD] run codespell throughout fixing typo automagically

c4d0dff

=== Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^

slint mentioned this pull request Feb 20, 2024

fix typos #2519

Closed

slint closed this Feb 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

codespell: add codespell config, workflow and some typos fixed#2470

codespell: add codespell config, workflow and some typos fixed#2470
yarikoptic wants to merge 8 commits intozenodo:masterfrom
yarikoptic:enh-codespell

yarikoptic commented Aug 30, 2023

Uh oh!

yarikoptic Aug 30, 2023

Uh oh!

yarikoptic Aug 30, 2023

Uh oh!

yarikoptic Aug 30, 2023

Uh oh!

Uh oh!

musvaage commented Nov 22, 2023 •

edited

Loading

Uh oh!

yarikoptic commented Nov 22, 2023

Uh oh!

musvaage commented Dec 16, 2023 •

edited

Loading

Uh oh!

yarikoptic commented Dec 16, 2023

Uh oh!

musvaage commented Dec 17, 2023

Uh oh!

yarikoptic commented Dec 18, 2023

Uh oh!

musvaage commented Dec 18, 2023

Uh oh!

slint commented Feb 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

yarikoptic commented Aug 30, 2023

Uh oh!

yarikoptic Aug 30, 2023

Choose a reason for hiding this comment

Uh oh!

yarikoptic Aug 30, 2023

Choose a reason for hiding this comment

Uh oh!

yarikoptic Aug 30, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

musvaage commented Nov 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yarikoptic commented Nov 22, 2023

Uh oh!

musvaage commented Dec 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yarikoptic commented Dec 16, 2023

Uh oh!

musvaage commented Dec 17, 2023

Uh oh!

yarikoptic commented Dec 18, 2023

Uh oh!

musvaage commented Dec 18, 2023

Uh oh!

slint commented Feb 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

musvaage commented Nov 22, 2023 •

edited

Loading

musvaage commented Dec 16, 2023 •

edited

Loading