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

[DOC] What's Here for Net:HTTP #128

Merged
merged 4 commits into from
Mar 5, 2023
Merged

[DOC] What's Here for Net:HTTP #128

merged 4 commits into from
Mar 5, 2023

Conversation

BurdetteLamar
Copy link
Member

This is off-page b/c its headers collide with those on the main page. Marking this as draft until that's agreed upon. Will also need to add link from main page.

@BurdetteLamar BurdetteLamar marked this pull request as draft February 27, 2023 14:01
@BurdetteLamar BurdetteLamar added the documentation Improvements or additions to documentation label Feb 27, 2023
doc/net-http/whats_here.rdoc Outdated Show resolved Hide resolved
doc/net-http/whats_here.rdoc Outdated Show resolved Hide resolved
@BurdetteLamar
Copy link
Member Author

Still missing a link to this from the main page. Where in the page should that be, do you think?

@peterzhu2118
Copy link
Member

I think this would make the most sense to live in the documentation for Net::HTTP. WDYT?

@BurdetteLamar
Copy link
Member Author

I think this would make the most sense to live in the documentation for Net::HTTP. WDYT?

I'd love that. But there are colliding headings. Those in the WH would have to be made less straightforward. Worth it?

Also, regardless of whether a link or the full text, where in the page?

@peterzhu2118
Copy link
Member

I'm not sure what the best solution to solving the heading collision is. I think the best way would be to embed this at the end of the Net::HTTP documentation rather than a link because a link introduces another level of indirection that makes it more difficult for the user to read and search.

@BurdetteLamar
Copy link
Member Author

I'm not sure what the best solution to solving the heading collision is. I think the best way would be to embed this at the end of the Net::HTTP documentation rather than a link because a link introduces another level of indirection that makes it more difficult for the user to read and search.

Done.

@BurdetteLamar
Copy link
Member Author

@peterzhu2118, ready for you.

lib/net/http.rb Outdated Show resolved Hide resolved
@BurdetteLamar BurdetteLamar marked this pull request as ready for review March 4, 2023 20:30
@peterzhu2118 peterzhu2118 merged commit 39e70f0 into ruby:master Mar 5, 2023
@hsbt
Copy link
Member

hsbt commented Mar 6, 2023

@BurdetteLamar This pull-request contains non-ascii character. see d22ca54

@BurdetteLamar
Copy link
Member Author

@BurdetteLamar This pull-request contains non-ascii character. see d22ca54

Thanks, @hsbt.

nagachika added a commit to nagachika/ruby that referenced this pull request Dec 16, 2023
…0a5659cadb49f1640b20896cd750decdbbd701,c8c3431b0a5995d58f97c511ffa0a39e0f19c75e,755c379d877c66916d20840f07738d6050da3ca2,030f39822ac9d6d7dcdb639e099b320d3517c19c,2f19c5b7e080f75c3373c5b1671b4d4cfab6d334:

	[ruby/net-http] [DOC] What's Here for Net:HTTP
	 (ruby/net-http#128)

	ruby/net-http@39e70f0f9b
	---
	 lib/net/http.rb | 269 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-
	 1 file changed, 267 insertions(+), 2 deletions(-)

	Replaced non-ascii charactor. It fails version detection at
	 `net-http.gemspec`.

	  >#   Returns the X509 certificate chain for the session<E2><80><99>s socket peer.
	---
	 lib/net/http.rb | 2 +-
	 1 file changed, 1 insertion(+), 1 deletion(-)

	[ruby/net-http] Test building packages

	Also revert commit ruby/net-http@d22ca54904de "Replaced
	non-ascii charactor. It fails version detection at `net-http.gemspec`."

	ruby/net-http@fbeb247d93
	---
	 lib/net/http.rb | 2 +-
	 1 file changed, 1 insertion(+), 1 deletion(-)

	[ruby/net-http] Read in binary mode to get rid of invalid byte
	 sequence

	ruby/net-http@38de3d17a7
	---
	 lib/net/http/net-http.gemspec | 11 ++++++++---
	 1 file changed, 8 insertions(+), 3 deletions(-)

	[ruby/net-http] Exclude git related files

	ruby/net-http@2767df580d
	---
	 lib/net/http/net-http.gemspec | 2 +-
	 1 file changed, 1 insertion(+), 1 deletion(-)

	[ruby/net-http] Re-apply
	 ruby/net-http@d22ca54904de after testing

	ruby/net-http@7ac7401a9c
	---
	 lib/net/http.rb | 2 +-
	 1 file changed, 1 insertion(+), 1 deletion(-)

	[ruby/net-http] Enhanced RDoc for Net::HTTP
	 (ruby/net-http#130)

	ruby/net-http@698e18cfc1
	---
	 lib/net/http/response.rb | 53 ++++++++++++++++++++++++++++++++----------------
	 1 file changed, 36 insertions(+), 17 deletions(-)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

3 participants