Skip to content

Add user guide#68

Merged
dgarciabriseno merged 13 commits intoHelioviewer-Project:mainfrom
dgarciabriseno:user-guide
Sep 8, 2022
Merged

Add user guide#68
dgarciabriseno merged 13 commits intoHelioviewer-Project:mainfrom
dgarciabriseno:user-guide

Conversation

@dgarciabriseno
Copy link
Collaborator

Adding some basic info to the user guide section on things I think users should know to work with this API.

@codecov-commenter
Copy link

Codecov Report

Merging #68 (3f5a7f3) into main (a12f594) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #68   +/-   ##
=======================================
  Coverage   99.48%   99.48%           
=======================================
  Files          23       23           
  Lines         586      586           
=======================================
  Hits          583      583           
  Misses          3        3           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@nabobalis
Copy link
Member

A general comment, on a thought that I keep switching between.

Would doubleback ticks for package name be better than bolding the package name?
Either hvpy or hvpy

@dgarciabriseno
Copy link
Collaborator Author

A general comment, on a thought that I keep switching between.

Would doubleback ticks for package name be better than bolding the package name? Either hvpy or hvpy

I like how it renders with the double backticks

With hvpy it links to the API reference, which I think is a bit redundant to have throughout the page since the reference is right there in the sidebar, and you're already on the hvpy docs, so it doesn't make sense to me for hvpy to be a link.

And bolded hvpy doesn't look as nice to me

@dgarciabriseno dgarciabriseno merged commit 7698bea into Helioviewer-Project:main Sep 8, 2022
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

Successfully merging this pull request may close these issues.

4 participants