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.

Sign up for GitHub

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

Jump to bottom

update docs #1

Open
stevengj opened this issue Mar 21, 2023 · 4 comments
Open

update docs #1

stevengj opened this issue Mar 21, 2023 · 4 comments

Comments

@stevengj
Copy link
Contributor

We decided that ruler.py was too generic a name, so I used imageruler as the name of the repo, and the program should be updated to match.

@mawc2019
@stevengj
Copy link
Contributor Author

stevengj commented Mar 26, 2023 •
edited
Loading

Partially addressed by #3. Mainly we just need updated docs and examples.

@stevengj stevengj changed the title rename to imageruler.py, update docs update docs Mar 26, 2023
@ianwilliamson
Copy link
Collaborator

With the name change from ruler -> imageruler, the import in the notebook example is now broken.

@mawc2019
Copy link
Collaborator

I will update this in a new PR. Additionally, two minor issues on file organization are pending. Any suggestions?

@stevengj
Copy link
Contributor Author

stevengj commented Apr 20, 2023 •
edited
Loading

Would be good to have a readthedocs manual generated from the code docstrings. See https://docs.readthedocs.io/en/stable/tutorial/index.html

stevengj pushed a commit that referenced this issue Mar 28, 2024
@mfschubert
Imageruler revamp (#30)
8820c26 
* Redo packaging using pyproject.toml and src layout (#1)

* Redo package

* Fix version number v0.1.0

* Formatting

* Docstring darglint

* Update imports

* Formatting

---------

Co-authored-by: Martin Schubert <[email protected]>

* Add py.typed

* Switch to tometrics algorithm

* Add mypy dep

* Add scipy dep

* Fix reference filename

* Type annotation

* Reference design readme

* Add docs deps

* Fix eof

* Fix naming

* Version updated from v0.1.0 to v0.2.0

* Add to_designs notebook

* Add skimage docs dep

* Add skimage docs dep

* Fix authorship in docs

* cleanup

* Notebook for ignore schemes

* Cleanup

* Fix module docstring

* Fix some typos

* Add performance comment

---------

Co-authored-by: Martin Schubert <[email protected]>
@stevengj stevengj mentioned this issue Mar 28, 2024
Closed
@mfschubert mfschubert mentioned this issue Apr 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@stevengj @ianwilliamson @mawc2019