You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "akesling (via GitHub)" <gi...@apache.org> on 2024/12/19 15:07:10 UTC

[PR] typo: remove extraneous "`" in doc comment [datafusion]

akesling opened a new pull request, #13848:
URL: https://github.com/apache/datafusion/pull/13848

   ## Which issue does this PR close?
   
   N/A
   
   ## Rationale for this change
   
   Improve documentation.
   
   ## What changes are included in this PR?
   
   typo: remove extraneous "`" in doc comment
   
   ## Are these changes tested?
   
   N/A
   
   ## Are there any user-facing changes?
   
   No


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] typo: remove extraneous "`" in doc comment [datafusion]

Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on PR #13848:
URL: https://github.com/apache/datafusion/pull/13848#issuecomment-2555620916

   Thanks @akesling I have changed the text, hope it is more clear now


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] typo: remove extraneous "`" in doc comment [datafusion]

Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on PR #13848:
URL: https://github.com/apache/datafusion/pull/13848#issuecomment-2555293664

   Would be that better WDYT @akesling ?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] typo: remove extraneous "`" in doc comment [datafusion]

Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on code in PR #13848:
URL: https://github.com/apache/datafusion/pull/13848#discussion_r1892821853


##########
datafusion/execution/src/runtime_env.rs:
##########
@@ -120,7 +120,7 @@ impl RuntimeEnv {
     ///
     /// # Example: Register local file system object store
     ///
-    /// To register reading from urls such as <https://github.com>`
+    /// To register reading from urls such as <https://github.com>

Review Comment:
   ```suggestion
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] typo: remove extraneous "`" in doc comment [datafusion]

Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on code in PR #13848:
URL: https://github.com/apache/datafusion/pull/13848#discussion_r1892823323


##########
datafusion/execution/src/runtime_env.rs:
##########
@@ -120,7 +120,7 @@ impl RuntimeEnv {
     ///
     /// # Example: Register local file system object store

Review Comment:
   ```suggestion
       /// # Example: Register remote URL object store like [Github](https://github.com)
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] typo: remove extraneous "`" in doc comment [datafusion]

Posted by "akesling (via GitHub)" <gi...@apache.org>.
akesling commented on code in PR #13848:
URL: https://github.com/apache/datafusion/pull/13848#discussion_r1892963062


##########
datafusion/execution/src/runtime_env.rs:
##########
@@ -120,7 +120,7 @@ impl RuntimeEnv {
     ///
     /// # Example: Register local file system object store

Review Comment:
   I'll defer to maintainers, but as a user I'd find that rather confusing given this is providing an example URL string as you would use in code, not a named service with associated link.
   
   I wasn't sure if this was supposed to have a balanced "`" or not, so sent this as removing it (since the link already highlights the example).



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] typo: remove extraneous "`" in doc comment, fix header [datafusion]

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #13848:
URL: https://github.com/apache/datafusion/pull/13848


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org