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

Feedback on openMINDS Python #7

Open
aeidi89 opened this issue Nov 13, 2023 · 3 comments
Open

Feedback on openMINDS Python #7

aeidi89 opened this issue Nov 13, 2023 · 3 comments

Comments

@aeidi89
Copy link

aeidi89 commented Nov 13, 2023

In the openMINDS Python page, could you please edit these sentences?

Python package for the openMINDS metadata framework. The package contains all openMINDS schemas as Python classes in addition to schema base classes and utility methods.

ALTERNATIVE 1:
The Python package for the openMINDS metadata framework contains all openMINDS schemas as Python classes in addition to schema base classes and utility methods.

ALTERNATIVE 2:
Here you can find the Python package for the openMINDS metadata framework. This package contains all openMINDS schemas as Python classes in addition to schema base classes and utility methods.

@lzehl
Copy link
Member

lzehl commented Mar 28, 2024

@aeidi89 thank you for this feedback.

We may consider ALTERNATIVE 1 for the GitHub description, but I personally I prefer how it is right now. I do not like ALTERNATIVE 2 (this is not how I would design GitHub repo short descriptions).

@apdavison @olinux @ehennestad please comment as well.

@ehennestad
Copy link

I prefer how it is now. I also dont like ALT 2

@apdavison
Copy link
Member

apdavison commented Mar 29, 2024

I think @aeidi89 is referring to the readthedocs documentation, which has anyway been rewritten since this issue was opened, not to the GitHub description.

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

No branches or pull requests

4 participants