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

Remove/reduce mentioning object classes in README #176

Closed
joshwlambert opened this issue Sep 5, 2023 · 3 comments
Closed

Remove/reduce mentioning object classes in README #176

joshwlambert opened this issue Sep 5, 2023 · 3 comments

Comments

@joshwlambert
Copy link
Member

Reading this from a user perspective I think that mentioning these different object classes could be confusing and not really important or significant for an external user. It would be necessary to either remove the text about the classes altogether or, if it's kept, add an explanation of what these classes are and why they are converted, which I don't know if this fits within a quick start section.

I was speaking with @jamesmbaazam about design vignettes and I think that this information about the object classes would be more fitting for this type of vignette rather than the Readme

Originally posted by @CarmenTamayo in #151 (comment)

@joshwlambert
Copy link
Member Author

There is now minimal reference to objects and classes in the README. Given how the <epiparameter> class is the core unit of the package I don't think it should be entirely removed from the README. @jamesmbaazam and @CarmenTamayo please let me know if you agree with how the current README is worded and formatted.

@jamesmbaazam
Copy link
Member

Thanks for the changes, Josh. It looks good to me.

@joshwlambert
Copy link
Member Author

Thanks @jamesmbaazam, I'll close this issue as there aren't any immediate changes required.

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

2 participants