llnl / llnl/Silo

fix documentation of facelist name in DBPutUcdmesh

Open
#182 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
45
Forks
27
Avg merge
12h 34m
Merged PRs (30d)
4

Description

The DBPutUcdmesh call the facelist name is the name of the external facelist. This is not made clear in the manual

-----------------------REDMINE MIGRATION-----------------------
This ticket was migrated from Redmine. As such, not all
information was able to be captured in the transition. Below is
a complete record of the original redmine ticket.

Ticket number: 2749
Status: New
Project: VisIt
Tracker: Bug
Priority: Normal
Subject: fix documentation of facelist name in DBPutUcdmesh
Assigned to: -
Category: -
Target version: -
Author: Mark Miller
Start: 02/02/2017
Due date:
% Done: 0%
Estimated time:
Created: 02/02/2017 08:34 pm
Updated:
Likelihood: 3 - Occasional
Severity: 2 - Minor Irritation
Found in version: 4.8
Impact:
Expected Use:
OS: All
Support Group: Any
Description:
The DBPutUcdmesh call the facelist name is the name of the external facelist. This is not made clear in the manual

Comments:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the manual entry for DBPutUcdmesh and review how the facelist name argument is described. Clarify that it refers to the external facelist, then verify that the updated wording is consistent with the surrounding API documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
database, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.