Skip to content

Conversation

@rajatkriplani
Copy link

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
It adds the glossary to computer vision concepts that may be useful for researchers.

What does this PR do?
Adds a glossary page in simple markdown format taking reference from movement

References

Closes #25 for now, more terms can be added later.

How has this PR been tested?

The new "Glossary" was built locally and it worked fine.

Is this a breaking change?

No, It's adds new docs page.

Does this PR require an update to the documentation?

Yes. This PR is a documentation update — glossary is a new addition to the documentation set.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@codecov
Copy link

codecov bot commented Apr 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.82%. Comparing base (5dbd591) to head (c333d26).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #79   +/-   ##
=======================================
  Coverage   98.82%   98.82%           
=======================================
  Files           5        5           
  Lines         255      255           
=======================================
  Hits          252      252           
  Misses          3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sfmig
Copy link
Member

sfmig commented Apr 8, 2025

Hi @rajatkriplani, thanks for having a go!

This looks good, but it would be great if we can implement the glossary as a sphinx directive. You can find more details here. It may take a while to understand and research how it works, but it seems worth it.

Feel free to have a go in this PR if you are interested!

@sfmig sfmig self-requested a review April 8, 2025 12:32
@rajatkriplani
Copy link
Author

rajatkriplani commented Apr 8, 2025

@sfmig earlier I forgot to build the glossary page, it's done now.

edit: Is rst format only for the glossary documentation, or should all the documents follow this format? Let me know so that I know whether to change the VIA labelling document as well.

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.

Add a glossary

2 participants