Potential revision to initial paragraph (courtesy of @yoyology)

Abierto
#207 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Sin datos de lenguaje
Estrellas
36
Forks
84
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de LibraryCarpentry/lc-data-intro

Todos los issues de LibraryCarpentry/lc-data-intro

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.