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

Organize modules sidebar #49

Open
16 tasks done
Tracked by #46
floralouise opened this issue Sep 1, 2024 · 0 comments · May be fixed by #50
Open
16 tasks done
Tracked by #46

Organize modules sidebar #49

floralouise opened this issue Sep 1, 2024 · 0 comments · May be fixed by #50

Comments

@floralouise
Copy link
Contributor

floralouise commented Sep 1, 2024

Based on conversations with @DarkMarmot , the plan is to organize the modules to better reflect the roadmap & best practices for the library.

Each module will also need to be edited so that the function docs show they are deprecated & there is text to refer ppl to the recommended functions instead.

Leave alone

  • HL7
  • HL7.Examples
  • HL7.Path

Deprecated: if the function had a long @moduledoc, moved that copy into a function doc for now for readability. Will be edited later in individual PR for that module.

  • HL7.FieldGrammar: Maybe hide later after public function docs updated
  • HL7.Header
  • HL7.InvalidGrammar: Maybe hide later after public function docs updated
  • HL7.Message
  • HL7.Parser: Maybe hide later after public function docs updated
  • HL7.PathParser: : Maybe hide later after public function docs updated
  • HL7.Query
  • HL7.RawMessage
  • HL7.Segment
  • HL7.Separators

Hide because they are internal

  • HL7.InvalidHeader
  • HL7.InvalidMessage
  • HL7.Lexers.Default
  • HL7.Lexers.DefaultWithCopy
  • HL7.Lexers.Dynamic
  • HL7.Lexers.DynamicWithCopy

Screenshot from discussion:
Screenshot 2024-09-01 at 9 42 28 AM

This was referenced Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant