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

Document interface #99

Open
moustachio-belvedere opened this issue Jan 13, 2021 · 3 comments
Open

Document interface #99

moustachio-belvedere opened this issue Jan 13, 2021 · 3 comments
Labels
documentation Related to documentation
Milestone

Comments

@moustachio-belvedere
Copy link
Member

As Ale mentioned in RHEOSafm issue JuliaRheology/RHEOSafm.jl#2, the RHEOS interface for contact models needs to be documented (and maybe tests added?)

I think once this is done, along with issue #93 we should probably consider releasing version 0.9.4?

@moustachio-belvedere moustachio-belvedere added the documentation Related to documentation label Jan 13, 2021
@moustachio-belvedere moustachio-belvedere added this to the 0.9.4 milestone Jan 13, 2021
@akabla
Copy link
Member

akabla commented Jan 13, 2021

Yes, a new release would be good so that the new doc is made available soon.

akabla added a commit that referenced this issue Apr 2, 2021
@akabla
Copy link
Member

akabla commented Apr 3, 2021

@Ab2425
While working on the doc for this section, I realise that the AFM interface is not named properly. I think we should call it "Hertz" as it is more about the Hertz contact model, rather than about the instrument used. If we don't change it soon, we'll get stuck once we add more contact models later. What do you think?

Ale, I think this would break the link with RHEOSafm, so we need a synchronize update if we go this way.

@akabla
Copy link
Member

akabla commented Aug 12, 2021

Good progress here, tests added, importcsv improved to match the usage of the new version #115
Documentation needs more examples, so moved to milestone 0.9.5.

@akabla akabla modified the milestones: 0.9.4, 0.9.5 Aug 12, 2021
@akabla akabla modified the milestones: 0.9.5, 0.9.6 Jan 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants