OpenGenus/cosmos

Adapt consistent format for functions

Open

#5.883 aberto em 23 de ago. de 2020

Ver no GitHub
 (3 comments) (2 reactions) (0 assignees)C++ (3.724 forks)batch import
Hacktoberfest

Métricas do repositório

Stars
 (13.462 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Pilha de tecnologia
Domain
Tipo Issue
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Prerequisites
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.