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

Improve overview of Choclo #32

Closed
3 tasks
santisoler opened this issue Feb 1, 2023 · 0 comments · Fixed by #37
Closed
3 tasks

Improve overview of Choclo #32

santisoler opened this issue Feb 1, 2023 · 0 comments · Fixed by #37
Labels
documentation Improvements or additions to documentation
Milestone
v0.1.0

Comments

@santisoler
Copy link
Member

santisoler commented Feb 1, 2023 •
edited
Loading

Page that contains the error or needs to be improved (paste link):

https://www.fatiando.org/choclo/latest/index.html

Description of the problem/suggestion:

The Choclo overview could be improved:

  • Plot results instead of printing huge arrays
  • Don't ravel the coordinates, redesign the example forward functions to handle broadcasting and raveling.
  • Fix rst format: some portions need to use the double tick to make them look like code rather than italics.
@santisoler santisoler added the documentation Improvements or additions to documentation label Feb 1, 2023
@santisoler santisoler added this to the v0.1.0 milestone Feb 10, 2023
@santisoler santisoler mentioned this issue Feb 11, 2023
Merged
santisoler added a commit that referenced this issue Apr 21, 2023
@santisoler
Improve Overview page in docs (#37)
2982459 
Avoid printing large arrays in Overview and add double backticks where
needed. Plot results of the forward models using matplotlib. Minor
improvements to the text. Mention matplotlib in the installation
instructions as it's being used for plotting the examples.


**Relevant issues/PRs:**

Fixes #32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.1.0
Development

Successfully merging a pull request may close this issue.

Improve Overview page in docs fatiando/choclo
1 participant
@santisoler