Contents
Table of contents
Annotations
CodeFlags are the annotations that you add to a piece of code (code snippet) within your project. They are synchronized with Predlab, they are always available to you, and your team. They are attached to your code via “code anchors”. They appear in real-time to your team mates.
What data does Predlab store when I add an annotation?
When you add an annotation (code flags), we synchronize these infos:
- The project ID to which the annotation belongs.
- The creator of the annotation (That is you).
- The markdown content that you added (the documentation content).
- The code snippet that you chose to document (You can choose not to share that)
- The current git branch.
- The current file path.
- The creation date.
I don’t want to share the code snippet with my annotation.
Who has access to the code snippets I include in my annotations?
If you select a code snippet before adding a code flag (annotation), your team members will be able to see in real-time from their live activity window.
What if I don’t want to include a code snippet in my annotation?
The code snippet sharing option is disabled by default. So no additional steps have to be made.
If you want to include the code snippet in the annotation, you have to explicitly check the checkbox that says “share code snippet” at the bottom of the code flag editor.