Comments (4)
Switching from ReST to Markdown is possible by using
https://www.mkdocs.org/ + https://mkdocstrings.github.io/ or mkautodoc or MkAPI
If we use ReST, I probably prefer Google-style docstrings
from dnaio.
I prefer ReST over markdown. I use ReST wherever I can. Markdown is simpler for tables, but that is about it. YMMV.
Anyway, google style looks good! A good docstring style does not use stuff like :param:
because that shows up when the user types help(func)
on the REPL as well. If it looks good on the REPL and sphinx can turn it into something nicely looking then it is fine with me.
Decide whether to use the RTD page as homepage URL
In my opinion the github page is better for this, as it also contains the issue tracker as well as a README with all the information one needs. Ideally the library is so pythonic that people can get away with not reading the documentation. (At least that is something to strive for ;-) ).
from dnaio.
It seems there’s a trend of moving away from ReST, which is why I brought this up. I don’t like a couple of things about ReST (mainly that I constantly have to lookup how to write certain constructs), so in a way I agree, but it also has some advantages over Markdown. I’ve gotten used it now, so let’s stick with ReST.
from dnaio.
I have now linked the documentation from the GitHub project and page and from within the README.
from dnaio.
Related Issues (20)
- SequenceRecord array class HOT 6
- Three-way is mate comparison HOT 2
- Switch single&paired API to single&multiple API. HOT 2
- Compilation error HOT 3
- Identifying bottlenecks HOT 4
- compresslevel and open_threads should be arguments in the dnaio.open interface
- Add better type hints for dnaio.open()
- ResourceWarnings HOT 3
- FastqFormatError, while reading in chunks HOT 5
- Use a newline index for FastqIter HOT 10
- Add ubam support HOT 11
- check quality score integrity HOT 1
- Version 1.0 HOT 3
- Typing warnings from mypy HOT 7
- How to cite dnaio in a manuscript? HOT 2
- Extended BAM support HOT 4
- _Py_NegativeRefcount error HOT 7
- dnaio.exceptions.UnknownFileFormat HOT 2
- Update bioconda-recipe to support osx-arm64 HOT 1
- installation from source with `pip install` fails HOT 2
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 dnaio.