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

RST: Option Lists not supported #10318

Closed
ZoomRmc opened this issue Oct 21, 2024 · 2 comments · Fixed by #10331
Closed

RST: Option Lists not supported #10318

ZoomRmc opened this issue Oct 21, 2024 · 2 comments · Fixed by #10331
Labels

Comments

@ZoomRmc
Copy link

ZoomRmc commented Oct 21, 2024

An Option Lists are a part of reStructuredText specs. Superficially looking I couldn't find any information on when it was included in the specs.

The following block (that adheres to the Option List specs) is currently read as a Definition List and a paragraph.

-a      Line
        Next-line
-b arg  Next-option
[ DefinitionList
    [ ( [ Str "-a" , Space , Str "Line" ]
      , [ [ Para [ Str "Next-line" ] ] ]
      )
    ]
, Para
    [ Str "-b" , Space , Str "arg" , Space , Str "Next-option" ]
]

I'm not sure if it's a bug or a feature request, as I'm not particularly interested in this part of the specs being supported. This issue is supposed to document pandoc not following the specification. I'm OK with closing it as not-planned or tagging as low-importance.

The main motivation for raising this issue is that I couldn't find any indication that this feature is not supported in pandoc docs. I think the docs should include a section which lists the cases where pandoc does not follow the specs of the supported formats (at least for readers) and known limitations of pandoc's native representation. If it's OK with the maintainers, I can either create a separate issue with this request or start small and make a PR with this addition to the docs.

@ZoomRmc ZoomRmc added the bug label Oct 21, 2024
@jgm
Copy link
Owner

jgm commented Oct 21, 2024

I think we could fairly easily support option lists.

Documenting all the reST features we don't support might be interesting, but I don't think it goes in the manual because it might be quite long, and because it would be odd to include this without similar sections about every other format (and that would be really long). We could think about including a separate document on the website, the way we have a document about Org-mode support.

@ZoomRmc
Copy link
Author

ZoomRmc commented Oct 23, 2024

Perhaps a convenient place for a permanent list of spec deviations is a big tracking issue right here that can be referenced and edited as things get implemented. It's also beneficial for potential contributors.

jgm added a commit that referenced this issue Oct 23, 2024
jgm added a commit that referenced this issue Oct 23, 2024
@jgm jgm closed this as completed in cd5dab1 Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants