Giter Site home page Giter Site logo

Comments (9)

luca-s avatar luca-s commented on July 19, 2024

I don't see the documentation in the sources . You can try add an example documentation in a similar way as the other plugins, that is the descriptions folder and the .rst file inside

from sed-seiscomp-contributions.

gempa-jabe avatar gempa-jabe commented on July 19, 2024

The doc is generated from the core datamodel description and dmsm is not part of the core. It can only be added to the eew doc which is not yet done.

from sed-seiscomp-contributions.

FMassin avatar FMassin commented on July 19, 2024

Thanks for your responses.

@gempa-jabe : Do you suggest that I should document dmsm and dmvs in EEW contrib and not here in SED contrib? Or just dmvs in EEW contrib ?

from sed-seiscomp-contributions.

gempa-jabe avatar gempa-jabe commented on July 19, 2024

I would document it where it is defined. SM in SED contrib and VS in EEW.

from sed-seiscomp-contributions.

FMassin avatar FMassin commented on July 19, 2024

Makes sense ok. Like this?

https://github.com/SeisComP/common/blob/879b778d1db00316b1f4206cb9ad482a5ba067a3/libs/seiscomp/datamodel/dataextent.h#L173-L176

I guess not exactly, because it's already there:
https://github.com/SED-EEW/SED-EEW-SeisComP-contributions/blob/3644da81b54ae4634c8719a94c9d92da1acb5024/libs/seiscomp/datamodel/vs/vs.h#L82

from sed-seiscomp-contributions.

gempa-jabe avatar gempa-jabe commented on July 19, 2024

What exactly do you want to achieve? To document the source code?

from sed-seiscomp-contributions.

FMassin avatar FMassin commented on July 19, 2024

Document the dmvs (and maybe dmsm?) data model extension in https://www.seiscomp.de/doc/base/api-python.html

from sed-seiscomp-contributions.

gempa-jabe avatar gempa-jabe commented on July 19, 2024

You can't document it there. There is no way.

from sed-seiscomp-contributions.

FMassin avatar FMassin commented on July 19, 2024

OK.

from sed-seiscomp-contributions.

Related Issues (5)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.