Cannot generate docs from flattened file

Abierto
#261 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
solidity, typescript

Línea de trabajo

Reproduce the issue with contracts/WrappedShift.sol by running the truffle-flattener command, then run npx solidity-docgen -i ./build/flattened/ and inspect how the flattened file is compiled. Done means documentation generation succeeds for build/flattened/WrappedShift.sol without the multiple SPDX license identifiers error.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Steps to reproduce:

  1. flatten: npx truffle-flattener ./contracts/WrappedShift.sol >> ./build/flattened/WrappedShift.sol
  2. generate docs: npx solidity-docgen -i ./build/flattened/

Error:

    Error: Solidity was unable to compile. build/flattened/WrappedShift.sol: ParserError: Multiple SPDX license identifiers found in source file. Use "AND" or "OR" to combine multiple 
    licenses. Please see https://spdx.org for more information.`
Lenguaje dominante
TypeScript
Estrellas
460
Forks
111
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OpenZeppelin/solidity-docgen

Todos los issues de OpenZeppelin/solidity-docgen

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.