Potential revision to initial paragraph (courtesy of @yoyology)

Aperta
#207 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

The suggested edits are in the issue body, and the work is explicitly deferred until the lesson migrates to the workbench platform. Read the lesson’s initial paragraphs after migration and compare them with the quoted recommendation. Done means revising the opening paragraph and removing the abbreviation reference from the second paragraph; first identify the migrated lesson file.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

good first issue

The following suggestion will need a PR opened after the lesson is migrated to the workbench platform:

I also feel that the initial paragraph of the lesson is difficult to understand. As it stands, the text reads

Regular expressions are a concept and an implementation used in many different programming environments for sophisticated pattern matching. They are an incredibly powerful tool that can amplify your capacity to find, manage, and transform data and files.

A regular expression, often abbreviated to regex, is a method of using a sequence of characters to define a search to match strings, i.e. “find and replace”-like operations. In computation, a ‘string’ is a contiguous sequence of symbols or values. For example, a word, a date, a set of numbers (e.g., a phone number), or an alphanumeric value (e.g., an identifier). A string could be any length, ranging from empty (zero characters) to one that spans many lines of text (including line break characters). The terms ‘string’ and ‘line’ are sometimes used interchangeably, even when they are not strictly the same thing.

I would recommend the following:

Many different programming environments require a way to match patterns of characters to do things like ensuring that an e-mail address is properly entered into an online form. A common tool for this purpose is regular expressions. Using regular expressions (or regex for short) allows you to amplify your capacity to find, manage, and transform data and files.

A regular expression is a method of using a sequence of characters to define a search to match strings, i.e. “find and replace”-like operations. In computation, a ‘string’ is a contiguous sequence of symbols or values. For example, a word, a date, a set of numbers (e.g., a phone number), or an alphanumeric value (e.g., an identifier). A string could be any length, ranging from empty (zero characters) to one that spans many lines of text (including line break characters). The terms ‘string’ and ‘line’ are sometimes used interchangeably, even when they are not strictly the same thing.

The only change to the second paragraph is to remove the reference to abbreviation, since I've moved that to the first paragraph.

Originally posted by @yoyology in https://github.com/LibraryCarpentry/lc-data-intro/issues/184#issuecomment-1015938853

Lingua principale
Nessun dato sulla lingua
Stelle
36
Fork
84
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di LibraryCarpentry/lc-data-intro

Tutte le issue di LibraryCarpentry/lc-data-intro

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.