Improve search behavior for specific keywords #25037
Conversation
--- Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
--- Signed-off-by: Michael Ferguson <mppf@users.noreply.github.com>
| if commentstarts > 0: | ||
| # reset indentation at the start of a block comment | ||
| #indentation = -1; | ||
| pass |
| @@ -102,21 +107,25 @@ def push_line(line): | |||
| # No need for trailing white space... ever | |||
| proseline = proseline.rstrip(' ') | |||
|
|
|||
| # Handle indentation | |||
There was a problem hiding this comment.
nothing that literate_chapel.py is also used for the blog so it would be good to make sure that none of the blog Markdown conversions are affected.
There was a problem hiding this comment.
Can you suggest how I can go about doing that?
There was a problem hiding this comment.
I think you would:
- Follow the steps in the README to build the
mainbranch ofchapel-blogwithCHPL_HOMEpointed to a version of the repo right before this PR
- This would involve running
./scripts/chpl_blog.py buildin the blog repo
- Preserve the
publicdirectory by renaming it to something (public-old) - Going back to the Chapel repo at
$CHPL_HOME, check out this PR; runbuildagain - Do a
diffonpublic-oldandold.
There was a problem hiding this comment.
There are whitespace changes but I think they're innocuous and the new result is more accurate.
An example, with this input within a comment:
/*
### First Solution: Hand-coded Interval Arithmetic
Here is a succinct solution for both parts in Chapel.
```Chapel
use IO;
var sumSubset = 0;
...
Now there are spaces in the visible code listing before the use and var lines.
This problem only affects 2 posts: aoc2022-day04-ranges (source of the above example) and netcdf1 (which has a minor difference that seems to be an improvement).
This PR improves the documentation search results for specific searches:
In order to do so, it adds
.. index::entries to the forallLoops.chpl and taskParallel.chpl primers. I added index entries for other sections present there, while there. To get these.. index::entries to work, I needed to updateliterate_chapel.pybecause it was de-indenting the lines following.. index::which lead to invalid RST.This PR also has a minor impact on the Chapel blog rendering (since the blog uses
chpl2rst.pywhich this PR modifies to support.. index::). Now whitespace is more accurately respected within the .rst comments.Reviewed by @DanilaFe - thanks!