OpenGenus/cosmos

Adapt consistent format for functions

Open

#5,883 建立於 2020年8月23日

在 GitHub 查看
 (3 留言) (2 反應) (0 負責人)C++ (3,724 fork)batch import
Hacktoberfest

倉庫指標

Star
 (13,462 star)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

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.

貢獻者指南