[jira] [Comment Edited] (SOLR-11715) Spatial Search ref-guide fixes

["Cassandra Targett (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SOLR-11715?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16275973#comment-16275973 ] 

Cassandra Targett edited comment on SOLR-11715 at 12/3/17 3:40 PM:
-------------------------------------------------------------------

bq. But is it really necessary to file a JIRA for ref guide changes?

My personal opinion is little changes like this don't need a JIRA, but if someone wants a review of their changes because they aren't sure if they've done something right, or worded it properly, etc., JIRA is really the only way to achieve that. And, obviously, non-committers would need a JIRA if they choose to contribute to the project by editing docs.

But, this patch doesn't appear to apply to master - the line numbers don't match up to master, and I can see section anchors that were removed after 6.6. If you want to make these changes, you should do them on master instead of branch_6x & backport (which will have merge conflicts, but the changes need to be on master first just like all other code changes).

Also, it seems it changes a few examples that are in source blocks (sections with {{\[source,<format>]}}) into lines with only the backtick style for making them monospaced - the preference is actually the opposite, to put all examples into source blocks. I know today we have a mix of approaches but over time as I edit other stuff I'm slowly trying to standardize on that approach.


was (Author: ctargett):
bq. But is it really necessary to file a JIRA for ref guide changes?

My personal opinion is little changes like this don't need a JIRA, but if someone wants a review of their changes because they aren't sure if they've done something right, or worded it properly, etc., JIRA is really the only way to achieve that. And, obviously, non-committers would need a JIRA if they choose to contribute to the project by editing docs.

But, this patch doesn't appear to apply to master - the line numbers don't match up to master, and I can see section anchors that were removed after 6.6. If you want to make these changes, you should do them on master instead of branch_6x & backport (which will have merge conflicts, but the changes need to be on master first just like all other code changes).

Also, it seems it changes a few examples that are in source blocks (sections with {{\[source,<format>]}} into lines with only the backtick style for making them monospaced - the preference is actually the opposite, to put all examples into source blocks. I know today we have a mix of approaches but over time as I edit other stuff I'm slowly trying to standardize on that approach.

> Spatial Search ref-guide fixes
> ------------------------------
>
>                 Key: SOLR-11715
>                 URL: https://issues.apache.org/jira/browse/SOLR-11715
>             Project: Solr
>          Issue Type: Bug
>      Security Level: Public(Default Security Level. Issues are Public) 
>            Reporter: Ishan Chattopadhyaya
>         Attachments: SOLR-11715.patch
>
>
> Was doing a demo of spatial search and ran into the following problems:
> # Some blocks of code were not formatted properly, hence losing the {{*:*}} parameters. Example: https://lucene.apache.org/solr/guide/6_6/spatial-search.html#SpatialSearch-bbox
> # The query mentioned for geodist section didn't actually return the scores. Need to add an fl parameter there. https://lucene.apache.org/solr/guide/6_6/spatial-search.html#SpatialSearch-geodist



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org