OpenGenus/cosmos

Adapt consistent format for functions

Open

#5 883 ouverte le 23 août 2020

Voir sur GitHub
 (3 commentaires) (2 réactions) (0 assignés)C++ (3 724 forks)batch import
Hacktoberfest

Métriques du dépôt

Stars
 (13 462 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

This is a(n):

  • New algorithm
  • Update to an existing algorithm
  • Error
  • Proposal to the Repository

Details:

I propose to adapt a consistent format for functions

 /* Description [What it does]
  *  - 
  * Arguments [The arguments and their type]
  *  - Arg_1 of type_n 
  *  - ...
  *  - - Arg_i of type_m
  * Return Value [What it returns and the type]
  *  -  ...
  *  
  */

This would give the code structure, prevent errors and achieve a specification to develop Hoare proofs for algorithms here.

Guide contributeur

Direction de recherche
Stack technique
Domaine
Type d'issue
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Prérequis
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.