Skip to content

edit intro.rst#90

Merged
havok2063 merged 6 commits into
mainfrom
docs_intro
Jun 3, 2026
Merged

edit intro.rst#90
havok2063 merged 6 commits into
mainfrom
docs_intro

Conversation

@astronomygupta

Copy link
Copy Markdown
Contributor

No description provided.

@havok2063 havok2063 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if the variable names are particularly confusing. If a user is learning Python, they should be learning the difference between a class name/object and variable name/object. I'm hesitant to put the release in the variable name. I've suggested some alternative variable names to use through the docs.

Comment thread docs/sphinx/intro.rst
Comment on lines +250 to 253
As noted above, most users will only need to use the `.Access` class.
Use the `.HttpAccess`, `.RsyncAccess`, and `.CurlAccess` classes only if you have some specific reason to use them instead of the `.Access` class.
Note that the syntax for `.HttpAccess` is different from the syntax for `.Access`, `.RsyncAccess`, and `.CurlAccess`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Access does not select HttpAccess. It only toggles between RsyncAccess and CurlAccess. HttpAccess is a different download mechanism.

Comment thread docs/sphinx/intro.rst
adding paths to ensure successful downloading of data.
adding paths to ensure successful downloading of data.

Using the `.HttpAccess` class.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this line has been removed. Can you add it back in down before the :: at line 254?

Comment thread docs/sphinx/intro.rst Outdated
Comment on lines 257 to 264
http_access_dr17 = HttpAccess(release='DR17', verbose=True)

# set to use remote
http_access.remote()
http_access_dr17.remote()

# get the file
http_access.get('mangacube', drpver='v3_1_1', plate='8485', ifu='1901', wave='LOG')
http_access_dr17.get('mangacube', drpver='v3_1_1', plate='8485', ifu='1901', wave='LOG')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think http_access is fine, but if you want to rename, maybe http or myhttp.

Comment thread docs/sphinx/intro.rst Outdated
Comment on lines 41 to 45
path_dr17 = Path(release='dr17')

# generate a file system path
path.full('mangacube', drpver='v3_1_1', plate='8485', ifu='1901', wave='LOG')
path_dr17.full('mangacube', drpver='v3_1_1', plate='8485', ifu='1901', wave='LOG')
'/Users/Brian/Work/sdss/sas/dr17/manga/spectro/redux/v3_1_1/8485/stack/manga-8485-1901-LOGCUBE.fits.gz'

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a huge fan of putting the data release in the variable name. It's maybe a little more confusing, and if we change the release example in the future, it's more docs to change.

If you want to rename the variable, I might suggest mypath or pathobj.

Comment thread docs/sphinx/intro.rst Outdated
# import the rsync class
from sdss_access import RsyncAccess
rsync = RsyncAccess(release='DR17')
rsync_dr17 = RsyncAccess(release='DR17')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think rsync is distinct enough from RsyncAccess to cause confusion, but if you want to rename maybe myrsync or rsyncobj?

Comment thread docs/sphinx/intro.rst Outdated
# import the curl class
from sdss_access import CurlAccess
curl = CurlAccess(release='DR17')
curl_dr17 = CurlAccess(release='DR17')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same thing with curl and CurlAccess. Maybe mycurl or curlobj.

@astronomygupta

astronomygupta commented May 5, 2026 via email

Copy link
Copy Markdown
Contributor Author

@havok2063 havok2063 self-requested a review June 3, 2026 20:33
@havok2063 havok2063 merged commit 46c388c into main Jun 3, 2026
10 checks passed
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.

2 participants