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

Update the readme documentation #108

Merged
merged 1 commit into from
Dec 1, 2018
Merged

Update the readme documentation #108

merged 1 commit into from
Dec 1, 2018

Conversation

0x1eef
Copy link
Contributor

@0x1eef 0x1eef commented Nov 29, 2018

Fix for #105 (comment)

Readme.md Outdated Show resolved Hide resolved
Readme.md Outdated

```ruby
if Pry::Prompt[:rails]
Pry.config.prompt = Pry::Prompt[:rails]
Copy link

Choose a reason for hiding this comment

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

I like this but would recommend providing instructions for pre Pry v0.12.0 as well:

# For Pry v0.12.0+
if Pry::Prompt[:rails]
  Pry.prompt = Pry::Prompt["rails"][:value]
end

# For Pry < v0.12.0
if defined?(PryRails::Prompt)
  Pry.config.prompt = Pry::Prompt::MAP["rails"][:value]
end

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i'm not sure it makes sense to provide documentation for an older API that pry-rails no longer implements.

Readme.md Outdated

```ruby
if Pry::Prompt[:rails]
Pry.config.prompt = Pry::Prompt[:rails]
Copy link

Choose a reason for hiding this comment

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

Just in case this got missed in force push:

I like this but would recommend providing instructions for pre Pry v0.12.0 as well:

# For Pry v0.12.0+
if Pry::Prompt[:rails]
  Pry.prompt = Pry::Prompt["rails"][:value]
end

# For Pry < v0.12.0
if defined?(PryRails::Prompt)
  Pry.config.prompt = Pry::Prompt::MAP["rails"][:value]
end

@0x1eef
Copy link
Contributor Author

0x1eef commented Nov 29, 2018

@pdobb i pushed again.

@pdobb
Copy link

pdobb commented Nov 29, 2018

Thanks very much! I was making a PR to help, but you were so fast! 👍

@0x1eef
Copy link
Contributor Author

0x1eef commented Nov 29, 2018

thanks :)

@0x1eef
Copy link
Contributor Author

0x1eef commented Nov 30, 2018

@kyrylo @rf- can you review please?

@rf- rf- merged commit a6c67b9 into pry:master Dec 1, 2018
@0x1eef 0x1eef deleted the update-docs branch December 2, 2018 01:23
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

4 participants