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

pick a convention for writing didymus #5

Closed
katyhuff opened this issue May 31, 2024 · 4 comments
Closed

pick a convention for writing didymus #5

katyhuff opened this issue May 31, 2024 · 4 comments
Assignees
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:4-Low This work is valuable, but not urgent or mission critical. Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Question This issue can be closed with a discussion and/or an answer.

Comments

@katyhuff
Copy link
Member

This will be complete when there is an established and documented convention for writing didymus.

@katyhuff katyhuff added Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:4-Low This work is valuable, but not urgent or mission critical. Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Question This issue can be closed with a discussion and/or an answer. labels May 31, 2024
@katyhuff katyhuff added this to the Establish Code Strcuture milestone May 31, 2024
@ZoeRichter
Copy link
Collaborator

The way I've been writing it so far has simply been all lowercase: 'didymus'. However, I'm not sure what the rule is for writing a proper noun like that when it's the first word of a sentence. Would I still keep it lowercase?

Another suggestion was to use a monospaced font like courier, which I think would 1) look nice 2) help it look more purposeful when it's the first word of a sentence and still lowercase (if we go that route). We could also write it in all caps: DIDYMUS.

Related to this - codes like numpy seem to have standard abbreviations when they are imported (np, in numpy's case) - I was using 'dy' without really thinking about it, but it occurs to me that it looks like dy, as in the change in the y component. It should probably be changed to di, or maybe dd or dm?

@katyhuff
Copy link
Member Author

katyhuff commented Jun 4, 2024 via email

@ZoeRichter
Copy link
Collaborator

'ddm' makes sense and is pretty short.

@katyhuff
Copy link
Member Author

Closed with ddm as selection.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:4-Low This work is valuable, but not urgent or mission critical. Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Question This issue can be closed with a discussion and/or an answer.
Projects
None yet
Development

No branches or pull requests

2 participants