Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README-developer: add contrib instructions, and update #27

Merged
merged 2 commits into from
Jun 6, 2018

Conversation

efiring
Copy link
Member

@efiring efiring commented Jun 6, 2018

No description provided.

@efiring efiring mentioned this pull request Jun 6, 2018
@efiring
Copy link
Member Author

efiring commented Jun 6, 2018

@DocOtak is there anything else that you think should be added?

@DocOtak
Copy link
Contributor

DocOtak commented Jun 6, 2018

@efiring That is probably good enough to avoid the easy style mistakes. There is a mix of tab and space characters which look ok in vim but really mess things up in the github diff (and probably other text editors).

Do we want to have an alphabetical ordering for added functions? I think they are currently this way because that is how cat stuck the individual files together.

It's probably my inexperience with C, but I had a difficult time figuring out what all the test_sub1 type functions were for in gsw_check_functions.c, eventually I figured out it was for functions that had pointers passed into them for return values (to support multiple return values)

@efiring
Copy link
Member Author

efiring commented Jun 6, 2018

@DocOtak The present set of files should be nearly tab-free--I might have left a few tabs in the files generated by scripts.
gsw_check_functions.c is probably hard to understand for anyone, regardless of experience level; if you would like to add some explanatory comments there, and/or some notes about it in the README-developer, that would be most welcome.
Ordering: yes, the alphabetical ordering is an artifact, but it's probably as good as anything, so we might as well keep it. I have added a paragraph to that effect.

@efiring efiring merged commit 8519abd into TEOS-10:master Jun 6, 2018
@DocOtak
Copy link
Contributor

DocOtak commented Jun 6, 2018

@efiring oh, I meant there was a mix of tabs and spaces in this README-developer file, sorry for not being specific.

@efiring
Copy link
Member Author

efiring commented Jun 6, 2018

Ouch! I thought my editor was fixing that, but evidently it is configured to do so only for recognized source files. I will fix it.

@efiring efiring deleted the update-README-developer branch June 6, 2018 21:20
@PaulMBarker
Copy link
Member

Hi,

I can not work out how to start a new topic, so I am going from here.

We have a computer programmer who is going to spend some time translating the matlab code to C.
I am guessing they will not get all of the missing codes converted but they will make a contribution. I have been asked to make a list of which programmes they want done in order of importance. Do you have a preference for which programmes are prioritised ?

Paul.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants