Skip to content

Commit 64ffceb

Browse files
update style guide link
1 parent 29a7807 commit 64ffceb

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

develop.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@ SUAVE merges new code contributions through [pull requests](https://help.github.
2828

2929
SUAVE is built on a slightly modified PEP8 style guide, with changes made to implement a data-oriented view of the code. To help support discovering code, the SUAVE folder structure explicitly mirrors the package structure. Flexibility of the package structure is important, so in general all objects live in their own file, with the same file name as the object name. In order to maintain a separation between Analysis and Data structures, there are often parallel package trees inside the main branches of the package, like SUAVE.Methods.Aerodynamics and SUAVE.Analysis.Aerodynamics. Where possible the names of fields that live in the SUAVE package are written out verbosely, avoiding jargon built on mathematical variable names or acronyms.
3030

31+
A [full description](https://github.com/suavecode/SUAVE/wiki/Style-Guide) of the style of SUAVE can be found on the [wiki](https://github.com/suavecode/SUAVE/wiki/Style-Guide).
32+
3133
Templates for new methods and objects can be found in the SUAVE repo's [templates](https://github.com/suavecode/SUAVE/tree/develop/templates) folder.
3234

33-
More detail on the style of SUAVE can be found on the [wiki](https://github.com/suavecode/SUAVE/wiki/Style-Guide).
3435

3536
### Prerequisites
3637

0 commit comments

Comments
 (0)