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

Fix the Marker Position in Some Code Snippets #5

Open
picnoir opened this issue Nov 14, 2018 · 2 comments
Open

Fix the Marker Position in Some Code Snippets #5

picnoir opened this issue Nov 14, 2018 · 2 comments
Labels
bug Something isn't working good first issue Good for newcomers Todo Validated Issue

Comments

@picnoir
Copy link
Owner

picnoir commented Nov 14, 2018

We have a problem when adding the line marker in the code snippets from our HTML Renderer. They are sometimes misplaced.

TBH, this feature has been added in a rush, there's some technical debt here.

  1. Refactor out the whole highLightOccs function from ProcessingSteps.hs to the Renderer/Html.hs file, it shouldn't be here in the first place.
  2. Re-think the API of the whole highlighting process to allow us to unit test this feature.
  3. Write some unit tests showing the current algorithm failing.
  4. Fix everything.
@picnoir picnoir added bug Something isn't working Todo Validated Issue good first issue Good for newcomers labels Nov 14, 2018
@picnoir
Copy link
Owner Author

picnoir commented Nov 14, 2018

@picnoir
Copy link
Owner Author

picnoir commented Nov 16, 2018

Loosely related small enhancements we probably could do while fixing this:

I find it pretty hard to find the ascii markers at a glance, though, mostly because they are indented. Would it be possible to mark that line with a colored bar on the left or something?

https://www.reddit.com/r/haskell/comments/9xax6d/exhack_a_haskell_examplebased_documentation_alpha/e9rvvju/

 add an <a name="#unique_id"/> before each example and a link near the location that point to that anchor. This way people can communicate more easily the example then they need to.

@Shamar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers Todo Validated Issue
Projects
None yet
Development

No branches or pull requests

1 participant