Comments (10)
And can I just say how much I hate having napari-hub require a separate description file, instead of using the README. You inevitably end up with this type of problem, where one is better than the other and only some of the information is in certain places.
I've heard all the arguments about how they're supposed to be two different documents aimed at different audience, but it just never seems to actually work out better in practice.
from affinder.
And can I just say how much I hate having napari-hub require a separate description file, instead of using the README.
The napari hub btw does use the README if one is available and no DESCRIPTION file is present.
The napari hub linter tool (or preview tool? I don't know what you call it) absolutely complains at you if there is no description file present. It's absolutely considers my plugins "unfinished" for the napari hub in that respect.
from affinder.
I don't think there's any particular reason @tlambert03! 😊 I think back when she made it we couldn't have mp4s render in READMEs? 🤷
from affinder.
Also, this description page is not included anywhere in the main docs at https://jni.github.io/affinder/ I think it should be included there too.
If you actually do make the description be the readme, perhaps that takes care of that problem (since the README is copied into the docs website).
from affinder.
Also, this description page is not included anywhere in the main docs at https://jni.github.io/affinder/ I think it should be included there too.
It is included under usage but the home page needs attention to make this obvious. I think I remember @jamesyan-git working on this and having to jump through a bunch of hoops to just include the DESCRIPTION.md doc rather than having to duplicate the information.
I'm actually +1 to just getting rid of the DESCRIPTION.md and making it the README. Like Genevieve says, the original argument that you'd maintain a separate description for the napari hub is maybe, nice, but I don't think it's nicer than having complete documentation on the docs website and on the repo. Keeping both in sync manually is a nightmare, so I think if the napari-hub wants to be able to display "subsets" of the information in the plugin's docs or README, there should be a mechanism to mark existing documentation as hub-relevant
or something, rather than having to maintain a separate doc.
from affinder.
And can I just say how much I hate having napari-hub require a separate description file, instead of using the README.
The napari hub btw does use the README if one is available and no DESCRIPTION file is present.
from affinder.
And can I just say how much I hate having napari-hub require a separate description file, instead of using the README.
you could add your voice to the hub discussion over in their repo 😂 more core devs saying this might actually make them budge a bit: chanzuckerberg/napari-hub#627
from affinder.
And can I just say how much I hate having napari-hub require a separate description file, instead of using the README.
you could add your voice to the hub discussion over in their repo 😂 more core devs saying this might actually make them budge a bit: chanzuckerberg/napari-hub#627
Ok, done: chanzuckerberg/napari-hub#627 (comment)
from affinder.
The napari hub linter tool (or preview tool? I don't know what you call it) absolutely complains at you if there is no description file present. It's absolutely considers my plugins "unfinished" for the napari hub in that respect.
Perhaps. But a README is always used if available and there's no DESCRIPTION file. If you find that's not the case, that's a bug.
from affinder.
The napari hub linter tool (or preview tool? I don't know what you call it) absolutely complains at you if there is no description file present. It's absolutely considers my plugins "unfinished" for the napari hub in that respect.
Perhaps.
There's no perhaps about it, I'm telling you what the behaviour is.
But a README is always used if available and there's no DESCRIPTION file. If you find that's not the case, that's a bug.
Yes, I already know this happens. That's slightly off-topic from the point I made here though.
from affinder.
Related Issues (20)
- Type error: missing a required argument 'layers' HOT 3
- multi-time-point multi-channel issues HOT 1
- Create close_affinder with magic_factory rather than magicgui
- Don't use a magicgui widget as a global store for attributes
- Add ability to automatically refine alignment once approximate alignment is found HOT 1
- Add ability to use RANSAC for robust registration with many points
- Task: update to npe2 HOT 2
- Allow alignment of mixed dimensionality layers HOT 2
- Task: Allow aligning non-image layers
- wheel building broken?
- Task: add tests for non-image alignment
- GitHub actions and Trove classifiers should be updated to drop Py3.7 and add Py 3.10
- refresh available layers in dropdown HOT 1
- Transformation matrix with skimage.transform.warp HOT 5
- Should add sample data
- Change docs theme to Pydata Sphinx theme
- Improve documentation, explaining how affinder works
- Add documentation URL to repo description HOT 1
- Extend affinder to 3D 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 affinder.