Docs: Built in functions shadow user variables

Ouverte Adaptée aux débutants
#905 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
1-3 heures
Accessibilité débutants
62/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
go
Domaine
documentation

Piste de recherche

Commencez par la définition du langage à l’adresse https://expr-lang.org/docs/language-definition et examinez la manière dont les fonctions intégrées sont documentées. Ajoutez un avertissement concernant les collisions de noms telles que count > 0, mentionnez le workaround $env.count et les options de l’API permettant de désactiver les fonctions, et ajoutez un lien vers la documentation de l’API.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

docs needed

Problem:

When using go-expr in default mode, functions are enabled. The function list includes some commonly defined variables, like count, and leads to expression compilation errors in cases like count > 0.

Solution:

The API exports functions that allow disabling a particular built-in function, or disabling them all. No implementation is necessary to work around the issue, and the issue also has other solutions like $env.count.

Proposal:

The language definition seems to be the canonical source of truth for which functions are implemented in go-expr. I'd like if a warning could be added that mentions the problem, and the option to disable the built in functions is possible via API.

Proposed text (discussion starter, MVP):

The built in functions may cause issues in evaluation when the variables share the same name. It's very common to use count > 0 expressions in simplistic checks, producing an error. You can change the expression to $env.count to avoid the issue. The API allows to disable built in functions, avoiding issues when you don't have control over the input and mainly want to use other features of expr like conditions and ternary operators. See the API documentation

Langage dominant
Go
Étoiles
8k
Forks
529
Aucune PR mergée en 30 j

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de expr-lang/expr

Toutes les issues de expr-lang/expr

Issues similaires

Plus d'issues Go

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.