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

correct reference to Remote.Sync.launcher #2652

Closed
wants to merge 4 commits into from

Conversation

ayushprd
Copy link
Contributor

Description

In book 7.2.3 Running SDA on remote, Remote.Sync.launcher is incorrectly referred to as Remote_Sync_launcher

Motivation and Context

Review Time Estimate

  • Immediately
  • Within one week
  • When possible

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Contributor

@istfer istfer left a comment

Choose a reason for hiding this comment

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

Thank Ayush, this is in itself consistent, so I'll approve this PR.

But in general, we try to avoid dots in function names, and I don't think Remote.Sync.launcher meant to use S3 methods, so eventually we would rather change the function name. But SDA people might have some custom scripts, and maybe this is not the best time to change the function name as it might break their analyses.

@mdietze
Copy link
Member

mdietze commented Jul 13, 2020

Could we fix the function name instead? Looking back at #2293 it looks like this function originally was called Remote_Sync_launcher. There were a TON of discussion points, so it wasn't easy to figure out if there was any argument made FOR using dots, but I suspect it just slipped in as even the inline documentation uses underscores.

Copy link
Member

@mdietze mdietze left a comment

Choose a reason for hiding this comment

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

@ayushprd just wanted to ping you to make sure you were going to get back to this PR.

@ayushprd ayushprd mentioned this pull request Aug 7, 2020
12 tasks
@ayushprd
Copy link
Contributor Author

ayushprd commented Aug 7, 2020

Sorry for the long delay. Closing fixing in #2676 . Here I had used develop branch by mistake.

@ayushprd ayushprd closed this Aug 7, 2020
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.

None yet

3 participants