Comments (5)
making type annotations mandatory for contributors
I'd be inclined to do so. I've seen many cases in which type annotations would have avoided a lot of bug hunting.
from psij-python.
I think it's detrimental to attempt global policies like this. If we try to make decisions that apply to many projects, it will create a strong incentive to ensure that the "right choice" is made, which can lead to endless discussions.
As far as I'm concerned, I will attempt to annotate the code that I produce. I don't want to go into a long debate about the pros and cons of strong typing or it's attempt to emulate it with mypy in Python, so I'll leave it at that.
from psij-python.
Oh, OK. From some of the comments I thought maybe you (or others) were thinking of making type annotations mandatory for contributors.
Even just for this repo, I think it might be good to have a one-sentence policy, saying whether they are optional/recommended/required. I was planning on contributing, and seeing all of the type-annotated code, I probably would have assumed they were required.
from psij-python.
👍 I would support a recommendation/requirement for type-annotations.
from psij-python.
Seems like we agree here that we should require type-annotations.
from psij-python.
Related Issues (20)
- Suggestion: Print out path to submit script if there is a submission error with batch jobs HOT 1
- Documentation: Additional details needed for `custom_attributes` HOT 4
- Retrieving the status of a submitted batch job returns `NEW` unless the user waits a few seconds HOT 14
- Properly implement wait()
- polling for jobs removed from the queue does not properly mark them as completed HOT 6
- Documentation: Example for how to load modules HOT 2
- Implement https://github.com/ExaWorks/job-api-spec/pull/168 HOT 1
- Implement https://github.com/ExaWorks/job-api-spec/pull/172
- Incorrect job duration formatting for SLURM HOT 2
- Proposal: Allow JSON-serializable format for `duration` in `JobAttributes` HOT 7
- `main` branch breaks `custom_attributes` (at least for Slurm) HOT 3
- Some words are cut off on PSI/J Python Webpage HOT 1
- Next steps for a new release? HOT 4
- The `environment` kwarg in `JobSpec` gets the wrong number of quotation marks if there are spaces HOT 4
- Not able to get ResourceSpecV1 working with PBS HOT 4
- PBS walltime hour is being formatted as a float causing job submission failure
- Account vs. project HOT 2
- Dependency on typeguard 2.12 conflicts with other packages. HOT 3
- Leftover of `distutils.` in 0.9.5 HOT 1
- Dependency `filelock` move to requirements-tests HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from psij-python.