Inconsistencies wrt relative paths in `referenced_filenames`

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#5,268 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 3 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
70/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
python, yaml
Domaine
documentation

Piste de recherche

Commencez par comparer les deux exemples de règles dans l’issue (mit_1356.RULE et apache-2.0_1122.RULE) afin de confirmer les motifs actuels de referenced_filenames. Trouvez ensuite dans le repo la documentation du format des règles ou la documentation du parser/schema, puis recherchez referenced_filenames afin de déterminer la convention prévue pour les chemins relatifs. Vérifiez les tests ou exemples existants liés au chargement des règles pour connaître le comportement attendu. C’est terminé lorsque la documentation définit explicitement le format canonique et que les exemples lui correspondent.

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

Description

bug improve-license-detection question
Description

This isn't so much a bug report as more of a question. I can see that in certain rule files there are relative paths in the license text, but in referenced_filenames it is inconsistent. Sometimes referenced_filenames includes the relative component (such as ..), other times it doesn't.

An example is mit_1356.RULE:

---
license_expression: mit
relevance: 100
is_license_reference: yes
referenced_filenames:
    - LICENSE
---

{{licensed under MIT}}, see ../LICENSE

while in apache-2.0_1122.RULE:

---
license_expression: apache-2.0
is_license_notice: yes
relevance: 100
referenced_filenames:
    - ../../../LICENSE
---

## License

This code is licensed under {{Apache-2.0 }}(../../../LICENSE).

I could not find any guidance in the documentation about what the correct way is.

Langage dominant
Python
Étoiles
2.7k
Forks
831
Merge moyen
3 j 4 h
PR mergées (30 j)
7

Préparer son environnement

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 aboutcode-org/scancode-toolkit

Toutes les issues de aboutcode-org/scancode-toolkit

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

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