search

ConaireD / TolimanWIP

WIP Toliman codes go here before being added to the main TOLIMAN github
Other
0 stars 0 forks source link

Implement `CONTRIBUTING.md`. #31

Closed Jordan-Dennis closed 1 year ago

Jordan-Dennis commented 1 year ago

Hi all. This is a personal reminder to set up the CONTRIBUTING.md file. This will need to be rather detailed since I am not using the standard setup for development. It will need to explain the use of poetry and black (see issues #20 and #14) respectively. Regards Jordan.

ConaireD commented 1 year ago

Will get to this (and everything else) tomorrow

Jordan-Dennis commented 1 year ago

Despite the fact I hated it in dLux, I am considering doing the from packge import ... convention. This is because I discovered the from package import () multiline version which is very similar to imports in go and I really like. This comment is not final and I may just leave it flexible.

ConaireD commented 1 year ago

I personally like the from x import y convention. It seems more accessible.

Jordan-Dennis commented 1 year ago

OK sounds good :+1:. However, there are a few nuainces when it comes to submodules. Is it from jax import numpy or from jax.numpy import arange, ....?

Jordan-Dennis commented 1 year ago

I have put together a quick explanation but it will probably need more detail as time progresses. For now I am closing the issue.