OpenGenus/cosmos

Adapt consistent format for functions

Open

#5883 aperta il 23 ago 2020

Vedi su GitHub
 (3 commenti) (2 reazioni) (0 assegnatari)C++ (3724 fork)batch import
Hacktoberfest

Metriche repository

Star
 (13.462 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Tech stack
Dominio
Tipo issue
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Prerequisiti
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.