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

Remove documents about deprecated/WIP features and some slight adjustments #811

Merged
merged 1 commit into from Dec 12, 2023

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Dec 12, 2023

No description provided.

@st0012 st0012 self-assigned this Dec 12, 2023
@@ -698,45 +698,6 @@
# and <tt>$DEBUG</tt> to +true+;
# these have no effect on \IRB output.
#
# === Tracer
Copy link
Member Author

Choose a reason for hiding this comment

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

Tracer integration needs some rework: #752

I'll add the documentation back once that's completed.

@@ -780,12 +741,6 @@
#
# Note that the configuration file entry overrides the command-line options.
#
# :stopdoc:
# === \IRB Loader
Copy link
Member Author

Choose a reason for hiding this comment

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

I don't feel IRB Loader should be exposed to end users.

@@ -850,12 +805,6 @@
#
# IRB.conf[:AP_NAME] = 'my_ap_name'
#
# :stopdoc:
# === \IRB Library Directory
Copy link
Member Author

Choose a reason for hiding this comment

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

This config is only used by the current tracer integration to skip IRB related traces. We don't need to disclose it in the doc.

@@ -872,12 +821,6 @@
# IRB.conf[:LC_MESSAGES]
# :startdoc:
#
# :stopdoc:
# === Single-IRB Mode
Copy link
Member Author

Choose a reason for hiding this comment

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

We're deprecating the multi-irb feature soon so let's not introducing the single/multi IRB concept.

# * Start the debugger of debug.gem.
# * break, delete, next, step, continue, finish, backtrace, info, catch
# * Start the debugger of debug.gem and run the command on it.
# Please use the `show_cmds` command to see the list of available commands.
Copy link
Member Author

Choose a reason for hiding this comment

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

We need to find a way to sync commands into the doc here. But for now, users can find them through readme or through the show_cmds command.

@@ -986,67 +866,6 @@
# If +line_no+ is a negative, the return value +line_no+ many lines before
# the most recent return value.
#
# ==== Example using IRB Sessions
Copy link
Member Author

Choose a reason for hiding this comment

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

The example here has a heavy focus on the multi-irb feature we plan to deprecate, which is a bit misleading.

@tompng tompng merged commit 6a9193e into master Dec 12, 2023
47 checks passed
@tompng tompng deleted the update-irb-document branch December 12, 2023 18:46
matzbot pushed a commit to ruby/ruby that referenced this pull request Dec 12, 2023
@nurse nurse mentioned this pull request Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants