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

Update link in glossary to use reST formatting #858

Merged
merged 1 commit into from
Apr 26, 2024

Conversation

bustosalex1
Copy link
Contributor

@bustosalex1 bustosalex1 commented Apr 26, 2024

I made a PR earlier today (#857) that updated the wording of an entry in docs/concepts/glossary.rst. Some additional info was added to the entry including a link, but it looks like the link was added in Markdown format instead of reST, which produces an unformatted link, as shown below:

Screenshot 2024-04-26 at 11 45 27 AM

I built the docs locally after updating to reST format, which now produces the following formatting:

Screenshot 2024-04-26 at 11 45 47 AM

Changes

  • Updated link to Code Organization in docs/concepts/glossary.rst to use reST formatting instead of Markdown formatting.

How I tested this

  • built docs locally using the instructions in README-DOCS.md and verified formatting of link.

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @bustosalex1 for catching that!

@skrawcz skrawcz merged commit 3e7626f into DAGWorks-Inc:main Apr 26, 2024
23 checks passed
@elijahbenizzy
Copy link
Collaborator

@bustosalex1 thank you! My bad, wrote that on the github PR. 🙌

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 this pull request may close these issues.

3 participants